【2023-03-24】-代码注释的重要性

关键字：代码、逻辑、注释

问题

现在企业招聘一个软件开发人员，一般都是要兼顾多个项目，在多个项目之间来回切换，如果项目的业务很大很杂，一个人不可能记得住所有的逻辑，每次都要去看一遍代码逻辑（1），然后恍然大悟，原来是这样的！！！
这样太影响效率，所以每天加班的都是你（哈哈哈），还有你是否经历过努力加班写完代码，结果再回过头，去看业务逻辑，发现写错了的尴尬场面，还有你是否经历过写一点代码，要看一下文档的重复性操作（2），这一切都是因为我们在学习写代码时忽略掉的一个重要的语法(注释)啊。

接下来我们通过注释 一一解决以上问题。

1. // 在入口写完整的代码逻辑 解决（1）
2. //如果所有逻辑都在一个方法里面，在关键代码上面写上注释或日志(日志既注释（3）)，如果按方法拆分，每个方法上面都要写注释，如果方法逻辑很简单可以不用，如果很难复杂要写注释。解决（2）
3. // 多看看开源代码或JDK核心代码，学习下什么是专业的代码注释规范（JavaDoc）。（我们是专业的）

首先我们要知道 java中有哪些注释语法。

// 单行注释（简要说明）常用于代码语句上方
/* 多行注释（详细说明） */ 常用于代码语句上方或方法第一行
/**
* 专业的代码注释规范
* <p>参考 java官方 javadoc文档</P>
* @link Javadoc tags | Documenting APIs (idratherbewriting.com)
*/

案例代码

/**
 *  转换为标准化表数据
 *  <p>
 *      <p>glptBankServer</p>
 *      FsIncomestockServiceImpl#saveOrupdateFsIncomeStocke
 *  </p>
 *  <p>
 *      2022-11-25  16:48
 *  </p>
 * @see NTStaController#ntAccBal(Long)

 * @author qr
 * @since 1.0
 **/

（3）这是我一直想买实现的一个功能