2016-12-21 21 views
2

javadocのタグ構文の例をコメントしたいと思います。 しかし、Javadocはそのコメントにタグを表示しません。 これは可能ですか?Javadocにタグを書き込む方法

サンプル:javadocがタグをコメントとして解釈しないため、svgタグのコメントは表示されません。

/** 
* 
* @param sMapData contains tags like the following sample : <br> 
* <svg><text color="000000" dates="-626,100;-545,100" fontsize="8" fs="normal" id="text31757_i1a" opa="1" text="L y d i a n" x="2915.5793" y="1889.9111"/></svg> 
* @return 
*/ 
+1

は(HTTP [Javadocコメントに複数行のコード例をここで見てください//stackoverflow.com/a/542142) – jensgram

答えて

2

this answerに複数行のコード例によると、Javadocコメントであなたは<pre></pre>に包まれ{@code }を使用することができます:

/** 
* 
* @param sMapData contains tags like the following sample: 
* 
* <pre> 
* {@code 
* <svg> 
* <text color="000000" dates="-626,100;-545,100" fontsize="8" fs="normal" id="text31757_i1a" opa="1" text="L y d i a n" x="2915.5793" y="1889.9111"/> 
* </svg> 
* } 
* </pre> 
* @return 
*/ 
+0

ありがとうございました!私はコードを文書化することが楽しいことを認識していませんでしたが、それは:-) –

関連する問題