Skip to content

Instantly share code, notes, and snippets.

@kencoba
Last active June 2, 2017 06:19
Show Gist options
  • Save kencoba/e4126aacd1077069212a3cf9698e6473 to your computer and use it in GitHub Desktop.
Save kencoba/e4126aacd1077069212a3cf9698e6473 to your computer and use it in GitHub Desktop.
Why we need comment on source code?

This is a good example. Fall-through works when we don't write anything. Without comment, reader can't see whether this code is correct or mistake.

飯尾淳「C言語によるスーパーLinuxプログラミング」、ソフトバンククリエイティブ、2011、p.112 Column10 フォールスルー ... ただし、フォールスルーの活用は1点、注意が必要です。 フォールスルーとして意図的にbreak文を省略したのか、プログラマーのミスでbreak文が省略されているのか、 プログラムのロジックから区別することができません。 したがってフォールスルーを使う場合には、コメントでそれがわかるように書いておくべきでしょう。

花井志生「モダンCプログラミング」、アスキー・メディアワークス、2013、p.99 4.1.2 状態遷移表 状態遷移図は見た目がわかりやすい反面、網羅性の確認が難しいという欠点もあります。 たとえば図4-1では、アイドル状態え[Stop]ボタンを押したときの挙動が書かれていません。 もちろんきっと何も起きないのだろうことは推測できますが、何も起きないので省略したのか、 書き忘れただけなのかは、読む側にはわかりません。

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment