软工学习笔记——代码规范

Posted 2020-07-27

上大学以来写了这几年的代码，却一直没怎么关注过代码规范相关的问题，直到软工课上讲了之后，才开始有所顾及。上课的时候回头看看自己写过的那些代码，真是丑死了，几个月前自己写的代码现在就已经读不懂了。

 

看了书上的相关章节，对于我来说，我觉得我的代码主要注意这几点：

 

1. 少写冗余代码，已经用不到的代码段就应该删去。（我今天刚刚发现我的昆特牌Online项目中竟然还存在有两个没用的类）

 

2. 多利用空行来将代码小规模地分段。

 

3. 大段的无用代码不要一直注释着，该删就删。（我的项目里经常会有一大堆没用的注释，非常影响代码阅读）

 

4. 减少重复代码，用函数或者类代替。

 

5. 多写注释，注释中写明白这部分的功能和变量、对象定义的含义。

 

6. 起名的时候要规范，一是意思要对，二是下划线、大小写的规则要统一。

 

7. 拆分非常大的类和方法，如果一个函数或者类太长，看起来会很吃力。