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

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

フォーマットスタイルに関しては、一貫性が最も重要です。すべてのクラス定義コメントが他のすべてのコメントのようになり、すべてのメソッドコメントが他のすべてのコメントのようになることを確認してください。

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

探し始める場所：

• Googleスタイルガイド（C ++、JavaScript、Objective-C、Python）
• Oracle JavaDocコメントの例