問題タブ [comments]

.ASPXクライアントに配信されないように、ページ内のマークアップをコメントアウトする方法はありますか? 標準のコメントを試してみました<!-- -->が、これはコメントとして配信されるだけで、コントロールのレンダリングを妨げません。

コメントのベスト プラクティスは何ですか? いつ使用する必要があり、何を含める必要がありますか? それともコメントが必要ですか？

私の同僚の何人かは、バグ修正について特別なコメントを使用しています。たとえば、次のようになります。

これは意味がありますか？
バグ修正について特別な方法でコメントしますか？

私にお知らせください。

私は Atlas に慣れており、(私が知っていることから) 推奨される方法は、次のような XML コメントを使用することです。

最近、他のサードパーティの JavaScript ライブラリを調べていると、次のような構文が表示されます。

おまけとして、「優先」コメント スタイルを読み取ることができる JavaScript 用の API ジェネレーターはありますか?

「ライブラリ」タイプのクラスを作成する場合、常にマークアップドキュメント（つまりjavadoc）をJavaで作成するか、コードを「自己ドキュメント化」できると想定する方がよいでしょうか。たとえば、次のメソッドスタブがあるとします。

javadocは自明のようであり、機能がまったく変更された場合に更新する必要があるノイズです。しかし、ストリームをフラッシュして閉じないことについての文章は価値があるかもしれません。

したがって、ライブラリを作成するときは、次のことを行うのが最適です。

a）常に文書化する
b）明白でないものはすべて文書化する
c）文書化しない（コードはそれ自体を語る必要がある！）

私は通常b）を使用します（コードは他の方法で自己文書化できるため）...

ではEclipse PDT、Ctrl-Shift-Fコードを再フォーマットします。ただし、コメントはまったく変更されません。不規則な複数行のコメントを 1 行あたり 80 文字 (または何でも) に再フォーマットする方法はありますか?

つまり変換

に

（これは通常のEclipseにも当てはまると思います。）

更新inモードは上記の行を再フォーマットEclipseしJavaますが、それらが /* */ スタイルのコメントである場合のみです。// 長すぎる行は短くなりますが、短すぎる行は結合されません。

Reddit のソース コードを見たことのある方は、コメントの階層構造を管理するロジックは正確にはどこにあるのでしょうか?

コードをダウンロードしましたが、コメント用の読み取りと書き込みがどこにあるのかは言うまでもなく、データベース構造さえ見つけることができませんでした。

誰かがスレッドの途中で誰かに返信した場合、多くのコメントを更新していますか?

コメントを入力すると、80 列の境界でコメントを自動的に折り返す方法はありますか? ..またはそれが失敗した場合、列 80 の境界にかすかな線を表示して、手動でのラッピングを少し簡単にする方法はありますか?

私が使用している他のいくつかの IDE には、これらの機能のいずれかがあり、適切な場所にラップするコメントをはるかに簡単/迅速に記述できます。

[編集] (私のように) Visual C++ Express を使用している場合は、キーの VisualStudio 部分を VCExpress に変更する必要があります。

他の質問も見ましたが、このテーマの扱い方にはまだ満足していません。

コード検査でコメントをチェックするために、抽出したもののリストを抽出したいと思います。

お互いに打ち消し合うようなことを言う人もいると思います。でもねえ、キャンプごとにリストを作成できるかもしれません。まったくコメントしない人にとっては、リストは非常に短いものになります:)

コードにコメントを付けることは、コードを次の人に、あるいは6か月かそこらで自分自身にさえ理解できるようにするためのコーディングスタイルの重要な部分であることは誰もが知っています。

ただし、コメントでマスタードが切れない場合もあります。私は明白なジョークやベントされたフラストラトンについて話しているのではなく、説明を試みているように見えるコメントについて話しているのですが、あまりにも貧弱なことをしていると、そこにいない可能性があります。コメントが短すぎる、不可解である、または単に間違っている。

おとぎ話として、あなたが見た中で本当にひどいものを共有できますか？それが明らかでない場合は、それが参照しているコードを示し、それの何が悪いのかを指摘してください。代わりにそこに何を入れるべきでしたか？

参照：

• コードにコメントしない場合
• コメントはいかがですか？（ベストプラクティス）
• これまでに出会ったソースコードの中で最高のコメントは何ですか？