Java代码注释标准解析

Posted 2021-12-24 小雨青年

一、写在前面

注释对于一个项目来说非常重要，好的注释可以让同项目的同学快速熟悉每个模块的作用。

二、代码注释 + JavaDoc

1.类注释

/**
 * 我是类注释
 * @author 作者
 * @since 2021-02-22 22:22
 * @version 1.1.1
 */

2.方法注释

    /**
     * 方法注释和类注释一样两个冒号开头
     * <p>
     * 描述
     * <p/>
     * 
     * @param parameterName  参数说明
     * @return return 返回值.
     * @throws exception 异常的描述
     */

3.行内注释

//我是行内注释

//@todo 还有的部分没做

/*
我也是行内注释
*/

三、注意事项

• 不要写标准里没有JavaDoc类型，不然IDE会提示
• 两个引号的注释不要写在行内

四、总结

1. 好的注释不在于多
2. 多的注释如果跟不上代码的修改就意味着变成了代码里的干扰项
3. 最好养成先沟通再写注释的习惯