我想在 javadoc 中评论示例标记语法。 但 Javadoc 不会在其注释中显示标签。 可以这样做吗?
示例:svg 标签注释未显示,因为 javadoc 不会将标签解释为注释。
/**
*
* @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
*/
最佳答案
根据this answer对于Javadoc注释中的多行代码示例,您可以使用 {@code }
包裹在 <pre></pre>
:
/**
*
* @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
*/
关于java - 如何在 Javadoc 中编写标签,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/41263172/