之前在看到一篇文章总结了How to write doc comments for the javadoc tools(https://www.oracle.com/technical-resources/articles/java/javadoc-tool.html,http://www.cnbl
How to Write Doc Comments for the Javadoc Tool 写在类上面的JavaDoc 写在类上的文档标注一般分为三段: 第一段:概要描述,通常用一句或者一段话简要描述该类的作用,以英文句号作为结束 第二段:详细描述,通常用一段或者多段话来详细描述该类的作用,一般每段话都以英文句号作为结束 第一段:概要描述 单行示例:...
How to Write Doc Comments for the Javadoc ToolJava Technical Details Technical ArticleJavadoc Home PageThis document describes the style guide, tag and image conventions we use in documentation comments for Java programs written at Java Software, Oracle. It does not rehash related material covered ...
How to Write Doc Comments for the Javadoc ToolJava Technical Details Technical ArticleJavadoc Home PageThis document describes the style guide, tag and image conventions we use in documentation comments for Java programs written at Java Software, Oracle. It does not rehash related material covered ...
How to Write Doc Comments for the Javadoc Tool 写在类上面的JavaDoc 写在类上的文档标注一般分为三段: 第一段:概要描述,通常用一句或者一段话简要描述该类的作用,以英文句号作为结束 第二段:详细描述,通常用一段或者多段话来详细描述该类的作用,一般每段话都以英文句号作为结束 ...
How to Write Doc Comments for the Javadoc Tool 写在类上面的JavaDoc 写在类上的文档标注一般分为三段: 第一段:概要描述,通常用一句或者一段话简要描述该类的作用,以英文句号作为结束 第二段:详细描述,通常用一段或者多段话来详细描述该类的作用,一般每段话都以英文句号作为结束 第三段:文档标注,用于标注作...
之前在看到一篇文章总结了How to write doc comments for the javadoc tools,觉得写得很好,为了自己记忆,在这里再总结一遍 1. javadoc第一行以两个*号开始,结尾是一个* /** * javadoc注释 */ 1. 2. 3. 2. 只负责描述类(class)、接口(interface)、方法(method)、构造器(constructor)、成员字段(field),在...
See @author in How to Write Doc Comments for the Javadoc Tool at https://www.oracle.com/technical-resources/articles/java/javadoc-tool.html#@author {@code text} Introduced in JDK 1.5 Equivalent to {@literal}. Displays text in code font without interpreting the text as HTML markup or nested...
HowtoWriteDocComments fortheJavadocTool Javadoc HomePage Thisdocumentdescribesthestyleguide,tagandimageconventionsweuseindocumentationcommentsfor JavaprogramswrittenatJavaSoftware,SunMicrosystems.Itdoesnotrehashrelatedmaterialcovered elsewhere: ●ForreferencematerialonJavadoctags,seetheJavadocreferencepages. ...
See @author in How to Write Doc Comments for the Javadoc Tool at https://www.oracle.com/technical-resources/articles/java/javadoc-tool.html#@author {@code text} Introduced in JDK 1.5 Equivalent to {@literal}. Displays text in code font without interpreting the text as HTML markup or nested...