2013-10-10 14 views
15

java注釈の内容については、Oracleのマニュアルを参照して検索しました。 @code @codeのJava注釈は何ですか

前の質問から、私はそれは、HTMLとは何かを持っていることに気づいたが、私は...

デフォルトのjavadocでHTMLとして解析されると言うことは正しいでしょう正確に何かわかりません。 .. @code注釈をjavadocテキストの隣に置くと、コードとして扱われ、通常の方法では解析/レンダリングされないことが示されます。 だから例えば:

/** 
    *This is how to declare an int variable {@code int var=1;} 
    */ 

はそれは、その使用の適切な例だろうか?

+0

どのライブラリからですか? –

+2

私はあなたがJavadocの上で、いくつかの説明を探していると思う: http://stackoverflow.com/questions/541920/multiple-line-code-example-in-javadoc-comment –

+0

[Javaを使用して、カスタムのテストランナーを作成します。アノテーション](http://www.singhajit.com/java-custom-annotations/) –

答えて

19

{@code }は、Javadocに中括弧内のテキストがコードであり、HTMLとして扱われないように指示するJavadocタグです。 Javadocは、コードブロック内のテキストを他のテキストとは異なる形式にする必要があります。これは、質問や回答の書式設定時にStackOverflowのエディタが使用する「コードサンプル」テキストと非常によく似た概念です。

+0

javaはデフォルトでコードをコードとして扱いませんか?なぜそれをHTMLとして扱うのでしょうか? – JMS

+1

JavaDocは、コードに関するHTMLドキュメントを生成するためのクラス、コンストラクタ、およびメソッドで使用できる、特別にフォーマットされたコメントです。たとえば、Java APIは完全にjavaDocedなので、オンラインまたはIDEで読むことができます。http://docs.oracle.com/javase/7/docs/api/自分自身を作成する方法の詳細は、http: //docs.oracle.com/javase/6/docs/technotes/tools/windows/javadoc.html – dkatzel

1

メソッドにJavaDocsを追加する場合。 たぶん、あなたは、Javadocの

enter image description here

だから黄色のものは、あなたがJavadocのようにメソッドのコードを追加したい場合は、あなたが他の人のために@codeでそれに注釈を付けることができ、ここでのJavadoc でいるかわかりませんこの方法を例にして見てください。 なぜそれを使用する必要があるのか​​?なぜなら、そうしないとフォーマットが正しく行われないからです。

あなたがそうでない場合に起こるフォーマットの変更をチェックするには、次の質問を参照してください。 @codeMultiple line code example in Javadoc comment

+0

ありがとうございます - あなたは例を挙げて明らかにすることができますか? – JMS

関連する問題