8
私は、プログラミングと英語の両方に関する質問があります。3行目を使用するか、1行のコードにコメントするかを必須にするかどうか。 コメントれるべき命令型言語に次のコード行を想定しますコメントのスタイル：命令または第三者
object.doSomething();
この行はこのように第三者を使用して、その背後にコメントを入れることであろうコメントする私のアプローチは、行を含む一般的な英語の文章になります対象として：
object.doSomething(); // does (referencing to the line of code) some action
しかし、我々は命令型言語ので、実際には「指揮」で、コンピュータであることから、1であっても、コードの前にコメントを入れて不可欠を使用して考えることができます：
//Do some action:
object.doSomething();
これは、相互に関連する複数の行をコメントする必要がある場合にも役立ちます。
私は個人的には最初のスタイルを好みますが、私はしばしばどのスタイルを使用するのか不明です。もしここでいくつかの個人的な経験を書くことができれば素晴らしいだろう。
質問する場所が間違っています。コメントはコードの言い換えではありません。コードの可読性を重視した書籍が全部あります。 –
行レベルのコードの意図についてコメントする必要があり、それが機械コードではない場合は、動詞の時制よりもさらに問題があります。私の個人的な経験は、狂気のようなコメント行為を勉強した人がコメントを維持しないということです。 –
@BasileStarynkevitch：この質問の抽象性と可読性を向上させるために、例を単純にしました。私はここでやっているように、言い換えればコードを言い直すのではなく、詳しく説明しています。どこに尋ねるのが適切でしょうか。私の意見では、この質問はコーディングに大きく関係しているので、私はStackExchangeフィッティングの英語フォーラムは表示されません。 – Paranaix