代码规范样例讨论-注释1

“其实没啥需要多说的,大家参照阿里 java 开发规范就好了。仅仅记录工作中遇到的讨论”

1 简单的逻辑注释是否真的需要?参照

王垠推荐的方法行数保持在40行,大约是电脑屏幕的高度。减少上下滑动的操作,可以更加专注。所以减少无用的注释。

2 由上面代码行数引出的一个问题,方法内的简单的注释是否可以放到方法的后面?比如这样? 我觉得是没问题的

参照:ali java规范 是强制要求的

3

注释写序号:疑问 1 2 3.有的写到  1.1  2.1 2.1 2.3...等等。如果我们要在中间插入一个新逻辑或者删除一个逻辑,那么序号都会乱掉,需要重新写序号。还是很耗时间的

猜你喜欢

转载自blog.csdn.net/f327888576/article/details/81094410
今日推荐