作者:微信小助手
发布时间:2023-05-18T16:27:06
我们开发完需求,提测前,一般都需要代码评审。小伙伴们,你们知道代码评审,一般都有哪些军规嘛?今天田螺哥给你带来代码评审的18个军规。 其实,写代码的时候,没有必要写太多的注释,因为好的方法名、变量名,就是最好的注释。以下就是笔者总结的一些注释规范: 以下就是一些添加注释的demo: 日志是快速定位问题的好帮手,是撕逼和甩锅的利器!打印好日志非常重要。如果代码评审的时候,这些日志规范没遵守,就需要修改:前言
1. 添加必要的注释
TODO
,也要注释清楚
//
;如果注释代码块或者接口方法的,有多行
/* **/
/**
* @author 田螺
* @date 2023/04/22 5:20 PM
* @desc 田螺的实现类,捡田螺、卖田螺 (更多干货,关注公众号:捡田螺的小男孩)
*/
public class TianLuoClass {
/**
* 这是卖田螺的两法,它将两个田螺的价格整数相加并返回结果。
*
* @param x 第一个整数
* @param y 第二个整数
* @return 两个整数的和
*/
public int sellTianLuo(int x, int y) {
return x + y;
}
}2.日志打印规范
error、warn、info、debug
四种,不要反手就是