JAVA项目文档注释规范&&生成自己项目的API文档

版权声明:本文为博主原创文章,转载请注明出处: https://blog.csdn.net/SL_World/article/details/78245722

一、项目文档开头注释

/**
 *  1.类的描述&&详细功能介绍
 *  2.@author  .....
 * /

二、每个方法的注释

/**
 *  1.方法的功能
 *  2.@param  n1  (形参解释含义).....
 *  3.@return  返回值   (有则写)
 * /

三、重难点或难理解代码注释
四、JAVA命名属性方式一般采用驼峰式,eg:getTest(); 而C语言一般采用下划线式,eg:get_test();

JAVA生成自己项目的API文档步骤:

1

2

3

4

生成后打开保存路径,在里面直接打开index文件即可浏览自己项目的API。

5

没有更多推荐了,返回首页