ん、まぁ、今日はそんな感じ( ´-ω-)

Profile

AkaSataNa

フォローする

私の仕事は、メモを残す事は極めて重要とされる。
いや、どんな仕事もそうか...まあ、今回はメモはメモでも、皆に見せるメモ。
C言語で書かれるソースコードに載せる、日本語コメントの話し。

ソースコードレビューとかで、見られるコメントの流儀は、人それぞれかなと思う。
まあ、それで良いかなっておもう。
コメントがあると、見落としは減るし、理解は早くなって助かるって思う。その反面、たまに間違ってるコメントに惑わされて、裏切られた！って思う気持ちになることも。まあ、トントンな気がしてる。

そんな自由なままで良いのに、ルールが適用されました。
ソースコードの関数(機能単位のソースコードのまとまり)には、記載行に対するコメント率が3割はなければいけない。

そもそもコメントも要らないくらいのシンプルな関数が望ましいのでは？

私としては、混乱する事が多く、地雷は踏み抜くタイプなので、物事はシンプルで引っ掛けが無い方が良いと思うんだけどなー

んー...ルール破りまくりそう。
ん、まあ、今日はそんな感じ( ´-ω-)σ

お気に入りの記事を「いいね！」で応援しよう