`
l19870104
  • 浏览: 7775 次
  • 性别: Icon_minigender_1
  • 来自: 广州
社区版块
存档分类
最新评论

Javadoc 包注释package.html 第一句

阅读更多

        众所周知,javadoc 对包的注释是在对应的包下面撰写名为package.html的文件。文件的第一行描述,将作为包概览和包概述页的描述。 而文件的<body></body>内部分,将完整地作为包概述页底部的描述。

如何区分第一行描述?

 package.html中,由英文句号“.”及中文句号“。”来区分第一行。 第一行数据只包括文本,而不包括标签。

该方式同样适用于类方法的描述。

分享到:
评论

相关推荐

    CheckStyle结果分析

    **说明**: Javadoc 注释的第一句话应该以句点结尾。 **解决方法**: 在第一句话后添加句点。 **示例**: ```java /** * This class represents a simple calculator. It provides basic arithmetic operations. *...

    javadoc使用指南

    * @param num1 第一个数字 * @param num2 第二个数字 * @return 两个数的和 */ public int add(int num1, int num2) { return num1 + num2; } } ``` - 然后在命令行运行`javadoc -d doc -sourcepath src ...

    JavaDoc写法规范

    1. **单行注释**:使用`//`符号来注释一行文本。 2. **多行注释**:使用`/* */`来注释多行文本。当多行注释前加上`/**`并以`*/`结束时,则该注释将被JavaDoc工具识别,并可以生成文档。 例如,下面是一段使用...

    javadoc 用法 详细说明 推荐

    * 汽车类具体阐述第一行 * 汽车类具体阐述第二行 * @author man * @author man2 * @version 1.0 * @see ship * @see aircraft */ public class Bus { /** * 用来标识汽车行驶当中最大速度 * @see #...

    poi-5.2.2.jar中文文档.zip

    解压 【poi-***.jar中文文档.zip】,再解压其中的 【poi-***-javadoc-API文档-中文(简体)版.zip】,双击 【index.html】 文件,即可用浏览器打开、进行查看。 # 特殊说明: ·本文档为人性化翻译,精心制作,请...

    mssql-jdbc-6.1.0.jre8.jar中文-英文对照文档.zip

    解压 【***.jar中文文档.zip】,再解压其中的 【***-javadoc-API文档-中文(简体)版.zip】,双击 【index.html】 文件,即可用浏览器打开、进行查看。 # 特殊说明: ·本文档为人性化翻译,精心制作,请放心使用。...

    完美Javadoc全接触

    - **包注释**:在包的路径下创建`package.html`文件,Javadoc在处理时会自动提取`package.html`文件中`&lt;body&gt;`元素的内容,并将其加入到`package-summary.html`文件中。 - **示例**: ```html This package ...

    jna-5.0.0.jar中文文档.zip

    解压 【jna-***.jar中文文档.zip】,再解压其中的 【jna-***-javadoc-API文档-中文(简体)版.zip】,双击 【index.html】 文件,即可用浏览器打开、进行查看。 # 特殊说明: ·本文档为人性化翻译,精心制作,请...

    jna-5.5.0.jar中文文档.zip

    解压 【jna-***.jar中文文档.zip】,再解压其中的 【jna-***-javadoc-API文档-中文(简体)版.zip】,双击 【index.html】 文件,即可用浏览器打开、进行查看。 # 特殊说明: ·本文档为人性化翻译,精心制作,请...

    javax.servlet-api-3.0.1.jar中文文档.zip

    解压 【javax.servlet-api-***.jar中文文档.zip】,再解压其中的 【javax.servlet-api-***-javadoc-API文档-中文(简体)版.zip】,双击 【index.html】 文件,即可用浏览器打开、进行查看。 # 特殊说明: ·本文档...

    bcprov-jdk15on-1.49.jar中文文档.zip

    解压 【bcprov-jdk15on-***.jar中文文档.zip】,再解压其中的 【bcprov-jdk15on-***-javadoc-API文档-中文(简体)版.zip】,双击 【index.html】 文件,即可用浏览器打开、进行查看。 # 特殊说明: ·本文档为人性...

    Eclipse中文教程.pdf

    1.Eclipse简介...........................................................................................................................................................8 1.1历史背景......................

    jna-5.6.0.jar中文文档.zip

    解压 【jna-***.jar中文文档.zip】,再解压其中的 【jna-***-javadoc-API文档-中文(简体)版.zip】,双击 【index.html】 文件,即可用浏览器打开、进行查看。 # 特殊说明: ·本文档为人性化翻译,精心制作,请...

    生成java项目chm格式api文档

    1. **生成Javadoc文档** - 打开命令行工具,进入你的Java项目目录。 - 使用以下命令生成HTML格式的API文档: ``` javadoc -d docs -sourcepath src -classpath path_to_dependencies YourPackage.YourClass... ...

    javax.servlet-api-3.1.0.jar中文文档.zip

    解压 【javax.servlet-api-***.jar中文文档.zip】,再解压其中的 【javax.servlet-api-***-javadoc-API文档-中文(简体)版.zip】,双击 【index.html】 文件,即可用浏览器打开、进行查看。 # 特殊说明: ·本文档...

    jna-4.5.2.jar中文文档.zip

    解压 【jna-***.jar中文文档.zip】,再解压其中的 【jna-***-javadoc-API文档-中文(简体)版.zip】,双击 【index.html】 文件,即可用浏览器打开、进行查看。 # 特殊说明: ·本文档为人性化翻译,精心制作,请...

    jaVA 第四章 接口与包.ppt

    Java还支持Javadoc注释,这种特殊的注释格式(以`/**`开始,以`*/`结束)用于生成API文档,通过`javadoc`工具可以自动生成HTML文档,方便开发者查阅。 总结来说,Java中的接口定义了行为规范,包提供了类和接口的...

    编程注释规范(JAVA)

    * @param a 第一个乘数 * @param b 第二个乘数 * @return 两数乘积 */ public int multiply(int a, int b) { return a * b; } ``` 3. **Javadoc注释**:Javadoc是一种特殊的多行注释,以`/**`开始,以`*/`...

    jna-5.4.0.jar中文文档.zip

    解压 【jna-***.jar中文文档.zip】,再解压其中的 【jna-***-javadoc-API文档-中文(简体)版.zip】,双击 【index.html】 文件,即可用浏览器打开、进行查看。 # 特殊说明: ·本文档为人性化翻译,精心制作,请...

    java 自己的doc文件生成 api说明文档工具2017

    1. **编写注释**:在源代码中,为类、接口、方法、变量等添加Javadoc注释。注释以`/**`开始,`*/`结束,中间包含描述性文字,如用途、参数、返回值、异常等。例如: ```java /** * 这是一个示例方法,用于... * ...

Global site tag (gtag.js) - Google Analytics