タグ付けされた質問 「comments」

コードでコメントを書くことについての質問。

7
コメント/コード内ドキュメントスタイル
これはばかげた質問かもしれませんが、しばらく頭の後ろにいて、他のどこにもまともな答えを見つけることができません。 私には、説明が1つしかない場合でも、各パラメーターと説明を明示的にリストする必要があると言う先生がいます。これは多くの繰り返しにつながります: double MyFunction(const int MyParam); // Function: MyFunction // Summary: Does stuff with MyParam. // Input: int MyParam - The number to do stuff with. // Output: MyParam with stuff done to it. コード内のドキュメントを書くとき、あなたはどのくらい詳細ですか?

5
コードコメントにJIRAの問題を含めることは、一般的に役立ちますか?
たまにはこういうコメントをします # We only need to use the following for V4 of the computation. # See APIPROJ-14 for details. または # We only need to use the following for V4 of the computation. # See https://theboringcompany.atlassian.net/browse/DIGIT-827 for details. そうすることに関する私の主な懸念は、JIRAへの依存度が高まることです。そのため、別のプロジェクト管理システムに移行する場合、これらのコメントはまったく意味がありません。近い将来に発生することは予測できませんが、組織コンポーネント(この場合は、コード、コードリポジトリ、プロジェクト管理システム)の結合の増加に引き続き注意します。 ただし、コードベース全体で、文書化された設計の決定と機能のインスピレーションへの参照があることの利点はわかります。私の知る限り、メリットは 設計の決定への明確な道筋。これは、見慣れないコードの特定のセグメントのデバッグと強化に役立ちます。 複数行のコメントが少ないため、コードがよりクリーンになり、新しい貢献者を脅かすことが少なくなります。 (潜在的に)現在の技術的および非技術的利害関係者への明確な道筋 前述の理由により、「なぜここにあるのか」という質問の数は減少しています。

3
ライブラリに慣れるために、ソースコードを読むよりもjavadocを読む方が望ましいですか。
私は大学の研究室のマニュアルで以下に出くわしました: javadocを生成してクラスのインターフェースを調べる必要があるので、提供される操作を確認できます(コードを自由に見てください。ただし、他の誰かのコードを使用する場合は、ここでは、javadocではなくjavadocから作業する必要があります)可能な限りコード)。 なぜそうなのか理解できません。javadocが古くなっている可能性があるか、コードの機能を不適切に説明している可能性があるためです。確かにソースコードを見て、javadocコメントを読むのが最善でしょうか? javadocのみを読むことが最善の方法である理由、またはその理由はありますか?

3
一部のopensouceライブラリにコメントがないのはなぜですか?
これがほとんどのオープンソースライブラリで発生するかどうかはわかりませんが、私が知っている多くのライブラリ(OpenSSL、Webkitなど)はすべてコメントがないか、コメントがほとんどありません。 非常に少数のドキュメントは言うまでもなく、ソースコードを読むのは困難です。メンバー変数が何を意味するのか、またはこの関数が何をするのかはほとんど理解できません。これはコーディング標準の慣行に反しているようです 何故ですか?コメントをほとんど付けずに、これらのオープンソースに人々が協力するにはどうすればよいですか

4
コードを無効にするための構文は、通常のコメントの構文と異なる必要がありますか?
開発中のいくつかの理由で、コードをコメントアウトすることがあります。私は無秩序で時々急いでいるので、これらのいくつかはそれをソース管理にします。 また、コメントを使用してコードのブロックを明確にします。 例えば: MyClass MyFunction() { (...) // return null; // TODO: dummy for now return obj; } これは「機能」し、多くの人がこのように実行しますが、コメント化されたコードとコードを明確にする「実際の」コメントを自動的に区別できないのは不愉快です。 コードを読み取ろうとするとノイズが発生します たとえば、ソース管理のon-commitフックのコメントアウトされたコードを検索することはできません。 一部の言語は、複数の単一行コメントスタイルをサポートする-例えばPHPにすることができますいずれかを使用//または#単一行コメントのために-と開発者がコメントアウトコードのためにこれらのいずれかを使用に同意することができます: # return null; // TODO: dummy for now return obj; 他の言語-私が今日使用しているC#など-は、単一行のコメントに対して1つのスタイルを持っています(そうですか?コンパイラディレクティブを使用した「コメントアウト」コードの例も見ました。これはコードの大きなブロックに最適ですが、ディレクティブには2つの新しい行が必要であるため、1行では少しやりすぎです。 #if compile_commented_out return null; // TODO: dummy for now #endif return obj; したがって、コメントアウトコードはすべての(?)言語で発生するので、「無効化されたコード」は言語仕様で独自の構文を取得すべきではありませんか?プロの(コメントの分離/無効化されたコード、エディター/ソースコントロールがそれらに作用する)は十分であり、短所(「コメントアウトはすべきではない」)であり、言語の機能的な部分ではなく、潜在的なIDEラグ(Thomasに感謝) ))犠牲に値する? 編集する 私が使用した例はばかげています。ダミーコードは実際のコードに置き換えられるため、簡単に削除できます。

6
<!— open->なぜ多くの開発者がHTMLでこれを行うのですか?<!— /閉じる->
&lt;body&gt; &lt;!-- wrapper --&gt; &lt;div id="wrapper"&gt; &lt;!-- title --&gt; &lt;div id="title"&gt;&lt;img src="title.png" alt="" /&gt;&lt;/div&gt; &lt;!-- form wrapper --&gt; &lt;div id="form_wrapper"&gt; &lt;!-- form --&gt; &lt;form action="thankyou.php" method="POST"&gt; &lt;!-- ... ... --&gt; &lt;/form&gt; &lt;!-- /form --&gt; &lt;/div&gt; &lt;!-- /form wrapper --&gt; &lt;/div&gt; &lt;!-- /wrapper --&gt; &lt;/body&gt; &lt;!-- /wrapper --&gt;タグ/ペアの開始から遠いので、最後のはほぼ理解できます...しかし、真剣に、コメント行の開始のポイントは何ですか?私がこれをいつも見ていなかったとしても、私は質問しません。 何か足りないような気がします。多分それが何であるかもしれないかを理解するのに失敗しますが、含まれているいくつかの書かれていないベストプラクティスがあります。恐らくそれは強迫的行動だけです。 マークアップがあるとしたら、通常はどうやってコメントを付けますか?
8 comments  html 

4
コメントはプログラミング言語の文法でどのように表現されますか?
文法を使用してパーサーを作成する方法を学習していますが、コメントをほとんどどこにでも表示できるため、コメントを表現するのに行き詰まりました。 これは、解析が行われる前に、コメントがトークンストリームから削除できることを示しています。 それは標準的な方法ですか、それともコメントは文法で指定されていますか?

8
解説スタイルは、読者がコードを理解する方法に影響しますか?
この質問は、過去2か月間私を悩ませてきました。 少し前に、優れたプログラマーである友人がいくつかのサンプルコードを教えてくれました。初めて、独自のコメント整理スタイルに気づきました。彼は私がコード自体をより快適にするような方法でコメントを設計するためにいくつかの努力をしました。例えば: ///////////////////////////////////////////// // // // This code prints a basic "Hello world" // // message to the console screen. You can // // change the text in the brackets. // // // ///////////////////////////////////////////// #include &lt;iostream&gt; int main() { cout &lt;&lt; "Hello world"; } 彼が単に書くことができたとき /* This code prints a …
8 comments 

11
ソース管理にコミットするときにコメントに何を入力すればよいですか?
この投稿を改善してみませんか?この質問に対する詳細な回答を提供してください。これには、引用や、回答が正しい理由の説明が含まれます。詳細が不十分な回答は編集または削除される場合があります。 私は孤独な開発者であり、ソース管理用のSVNサーバーを維持しています。これまでのところ、私は自分の変更をコミットする間、特定のことを行っていません。 私は以前のコミットを確認しているだけで、コメントを理解することができませんでした。 チェックインをコミットするときにコメントに何を入れますか?
弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.