web-dev-qa-db-ja.com

Javaコメント規約

どのコメント方法が最も広く受け入れられていますか、それとも本当に重要ですか?

私は使用しています

/**  
 * (Method description)
 * @param
 * @return
 * etc
 */

しかし私は読んだ:

Precondition:
Postcondition:

より「プロフェッショナルな」コメント方法はありますか?

22
Garee

オラクルが推奨するコメントのJavaコーディング規約は次のとおりです。

Googleが推奨するAndroidプラットフォーム:

Javadocのスタイルと規則の詳細については、以下を参照してください。

21
Gunslinger47

まず、可読コードと可読コメントを持つことは、まったく異なる2つのことです。

読み取り可能なコードは、適切な変数、メソッド、クラス名などを使用するコードです。

読みやすいコメントは、個人的な好みの問題です。本を書くのに使用される文法規則に従うコメントを好む人もいれば、文法についてあまり気にしない人もいます。あなたはこのリンクを通過することができます:

http://www.Oracle.com/technetwork/Java/codeconventions-141999.html#385

読みやすいコードとコメントから、doxygenを使用してドキュメントを作成できます。

http://www.doxygen.nl/manual/docblocks.html

1
Siddh

最初の例のコメントスタイルは単なる規則ではなく、 Javadoc と呼ばれるドキュメンテーションツールの標準です。そのJavadocコメントスタイルに従うと、すべてのソースコードのhtml形式のドキュメントを簡単に生成できます。

1
Arnold Spence

これ リンクは非常に有用であり、私はこれを長い間使用しており、多くの助けをしてくれました。これにより、非常に優れたドキュメント化されたコードが作成され、最大限の準備が整います。

0
Nitesh Verma

私は、Javadocを作成するために、Sun(Oracle)によって定義された標準に従うだけです。 Javadocは満場一致ですべての開発者から参照されています:)。詳細については ここ をクリックしてください

また、コメントに関する多くの質問と回答について、次の Stackoverflowでの検索 を実行するようにお願いします。

https://stackoverflow.com/search?q=commenting

0
YoK