软件编码规范与技巧

经过长达4个月之久的实际项目锻炼，总结一下编码方面的规范以及技巧：

1. 在定义变量时，尽量使用有意义的变量名称，如docID，contentList等，拒绝使用如a,b,c或list1,list2等；
   变量的格式采用驼峰式，如contentList，而非ContentList等；

2. 函数定义与变量的定义类似，采用有意义的名称，并且每个单词首字母大写，但函数首字母小写，如getCategoryList；

3. 类的定义首字母大写，而且每个单词的首字母都大写，如PageDocument;

4. 定义package时，会要求首字母小写，并且采用多层次的package，如org.example.anttest;

5. 保持类的封装性，最好把变量全都设置为private， 采用方法来获取或修改变量，而不在类的外部直接修改类的变量。
   如定义类PageDocument：

   public class PageDocument{

    private String content ="";

    private void setContent(String content){
         this.content =content;
     }

    public String getContent(){
         return this.content;
     }
   }

    这样用get或set方法来获取类PageDocument的属性值。


6. 编码过程中难免遇到for,while循环， 尽量把循环体中与循环变量无关的定义/计算提到循环外部，如

      for(int i=0;i<100;i++){
           ....

        //这一段最好提到循环外部
          int b =2;
          int c =3;
          int j =5*(b+c);

       ...
       }
    
       最后，强调在编码过程中尽量不要使用copy, paste这种方式，用组长的话来说，虽然这种编码方式最简单，但是也最容易出错，最难维护，最不能提升个人的能力。