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

Javadoc 包注释package.html 第一句

阅读更多

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

如何区分第一行描述?

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

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

分享到:
评论

相关推荐

    plexus-compiler-javadoc-2.2-7.el7.x64-86.rpm.tar.gz

    在安装完成后,plexus-compiler-javadoc将会被添加到系统中,通常这个过程会涉及到Javadoc工具的集成,它是一种自动生成文档的工具,用于从Java源代码中提取注释并生成文档。这个软件包可能是某个更大软件项目的组成...

    CheckStyle结果分析

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

    maven-ear-plugin-javadoc-2.8-5.el7.x64-86.rpm.tar.gz

    1. Maven插件:maven-ear-plugin是Maven的一个专门用于构建EAR文件的插件,它简化了EAR文件的打包过程,使得Java EE项目部署更加高效。 2. Javadoc生成:maven-ear-plugin-javadoc-2.8-5.el7.noarch.rpm文件名中的...

    maven-dependency-plugin-javadoc-2.7-3.el7.x64-86.rpm.tar.gz

    第一步,通过tar命令解压压缩包,获取到RPM包文件。具体命令如下: ```shell tar -zxvf /mnt/data/output/maven-dependency-plugin-javadoc-2.7-3.el7.tar.gz ``` 第二步,进入解压后的目录,并执行RPM安装命令...

    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 #...

    完美Javadoc全接触

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

    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】 文件,即可用浏览器打开、进行查看。 # 特殊说明: ·本文档为人性化翻译,精心制作,请放心使用。...

    jna-5.0.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】 文件,即可用浏览器打开、进行查看。 # 特殊说明: ·本文档...

    easy_javadoc-java开发项目资源

    文档注释,或称为Javadoc,是Java语言的一种特殊注释方式,它能够通过文档生成工具自动提取源代码中的特定注释,并生成标准化的API文档。因此,对于一个名为"easy_javadoc-java开发项目资源"的文件集合,我们可以...

    jna-5.4.0.jar中文文档.zip

    解压 【jna-***.jar中文文档.zip】,再解压其中的 【jna-***-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.5.0.jar中文文档.zip

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

    jna-5.6.0.jar中文文档.zip

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

    jaVA 第四章 接口与包.ppt

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

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

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

Global site tag (gtag.js) - Google Analytics