标签：microsoft 编写程序 介绍 family href bsp 就是 英文 开发
一、Javadoc的基本信息：
javadoc是Sun公司提供的一个技术，它从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。也就是说，只要在编写程序时以一套特定的标签作注释，在程序编写完成后，通过Javadoc就可以同时形成程序的开发文档了。javadoc命令是用来生成自己API文档的，使用方式：使用命令行在目标文件所在目录输入javadoc +文件名.java。
Javadoc主要用于代码的注释规范性。
二、Javadoc的基本用法
1.1主要讲述写在类上面的Javadoc用法
写在类上的文档标注一般分为三段：
在注释中出现以@开头东东被称之为Javadoc文档标记，是JDK定义好的，如@author、@version、@since、@see、@link、@code、@param、@return、@exception、@throws等。
主要的文档标记
@link的使用语法{@link 包名.类名#方法名(参数类型)}，其中当包名在当前类中已经导入了包名可以省略，可以只是一个类名，也可以是仅仅是一个方法名，也可以是类名.方法名，使用此文档标记的类或者方法，可用通过按住Ctrl键+单击 可以快速跳到相应的类或者方法上，解析成html其实就是使用< code> 包名.类名#方法名(参数类型)< /code>
{@code text} 会被解析成<code> text </code>
将文本标记为代码样式的文本，在code内部可以使用 < 、> 等不会被解释成html标签, code标签有自己的样式
一般在Javadoc中只要涉及到类名或者方法名，都需要使用@code进行标记。
一般类中支持泛型时会通过@param来解释泛型的类型
详细描述后面一般使用@author来标记作者，如果一个文件有多个作者来维护就标记多个@author，@author 后面可以跟作者姓名(也可以附带邮箱地址)、组织名称(也可以附带组织官网地址)
@see 一般用于标记该类相关联的类,@see即可以用在类上，也可以用在方法上。
@since 一般用于标记文件创建时项目当时对应的版本，一般后面跟版本号，也可以跟是一个时间，表示文件当前创建的时间
@version 用于标记当前版本，默认为1.0
@param 后面跟参数名，再跟参数描述
@return 跟返回值的描述
用于标注在常量上，{@value} 用于表示常量的值
1）概要描述：通常用一句或者一段话简要描述该类的作用， 如：
2）详细描述 ------ 详细描述和概要描述要求要空一行
详细描述一般用一段或者几个锻炼来详细描述类的作用，详细描述中可以使用html标签，如<p>、<pre>、<a>、<ul>、<i>等标签， 通常详细描述都以段落p标签开始。<a>一般用于标注出现的组织的链接
1.2 javadoc写在方法上的文档标注一般分为三段：
标签：microsoft 编写程序 介绍 family href bsp 就是 英文 开发
原文地址：https://www.cnblogs.com/qwq-sss/p/11799362.html
