标签：Java String Javadoc 生成 注释 添加 文档 name

Java添加文档注释

• 可以给类添加注释，也可以给函数添加注释；
• 添加注释的方法是，输入/**然后回车，会自动生成输入、输出和异常

/**
 * @author happy
 * @version 1.0
 * @since 1.8
 */
public class type {
    String name;
	/**
     *
     * @param name
     * @return
     * @throws Exception
     */
    public String test(String name) throws Exception{
        return name;
    }
}

生成文档

生成文档有两种方式，命令行生成或者使用编辑器（比如Idea）生成

命令行生成文档

• 终端中，进入到要生成文档的文件的位置，然后执行以下命令：

$ javadoc -encoding UTF-8 -charset UTF-8 type.java

• 进入对应的文件夹，即可看到生成的文件
  

使用Idea生成文档

可以选择生成整个项目的文档，也可以选择生成单文件的文档，文档生成后，会自动打开

标签：Java,String,Javadoc,生成,注释,添加,文档,name
来源： https://www.cnblogs.com/ying1761/p/15730442.html

本站声明： 1. iCode9 技术分享网（下文简称本站）提供的所有内容，仅供技术学习、探讨和分享；
2. 关于本站的所有留言、评论、转载及引用，纯属内容发起人的个人观点，与本站观点和立场无关；
3. 关于本站的所有言论和文字，纯属内容发起人的个人观点，与本站观点和立场无关；
4. 本站文章均是网友提供，不完全保证技术分享内容的完整性、准确性、时效性、风险性和版权归属；如您发现该文章侵犯了您的权益，可联系我们第一时间进行删除；
5. 本站为非盈利性的个人网站，所有内容不会用来进行牟利，也不会利用任何形式的广告来间接获益，纯粹是为了广大技术爱好者提供技术内容和技术思想的分享性交流网站。