web-dev-qa-db-ja.com

ヘッダーコメントフォーマット

「ヘッダーコメント」の形式はプログラマーによって異なることに気づきましたが、「良い」ヘッダーコメントの例は何でしょうか?

10
Mateen Ulhaq

フォーマットスタイルに関しては、consistencyが最も重要です。すべてのクラス定義コメントが他のすべてのコメントのように見えるか、すべてのメソッドコメントが他のすべてのコメントのように見えるかを確認します。

したがって、既存のコードを変更する場合は、それらのフォーマットスタイルに従っていることを確認してください。コメント(およびある程度、コード)は、1人のユーザーだけがファイルに取り組んだように見える必要があります。新しいプロジェクトを開始する場合は、1つのスタイル形式を選択し、それを使い続けます。

探し始める場所:

5
J.K.