在初学阶段良好的编码习惯会让你在以后的工作中更加得心应手,个人常常在团队中强调的几点:
1. 注释
无需多言,从上学学编程开始老师就说过的编码注释是个良好的习惯,在c#中增加了///的注释方式请善用,这样在半年后看自己的代码的时候不会发生【我是谁,我在那,那个傻x写的代码】奇景,
我要补充说的一点就是,对逻辑复杂的程序增加逻辑说明注释真的能为你以后的维护省心很多
2. 变量命名规范
这个就不说废话,常用的驼峰命名方式Java的同学已经飘然而过,不说别的,光代码看起也美观不少,你看 myname 和MyName看起来是不是差很多,另外类名和变量名区分要根据你以后工作的团队来确定,一般我们这边是类用首字母大写,方法则是首字母小写和驼峰命名结合。
3. 降低程序的耦合
从软件开发的角度,松耦合代表的就是高容错,如果对性能影响不大的情况下,精良不要把所有的逻辑写进一个模块,比如
public class MyClass{
public void Main(){
A();
B();
}
public void A(){
//doSomething
}
public void B(){
//doSomething
}
}
就不如写成:
public class MyClass{
public void Main(){
var cLib = new CommLibs();
cLib.A();
cLib.B();
}
}
public class CommLibs{
public void A(){
//doSomething
}
public void B(){
//doSomething
}
}
5. 程序日志
程序的日志很重要,对于一些特殊的环境下故障的排查很有用,一旦发生异常能迅速定位发生部位,所以在程序中核心模块合理增加日志功能很有必要。
推荐使用NLog,可以在nuget中获取到最新版本。