工作中的代码规范
在工作学习中,自己总结的编码习惯(工作几个月,再回头看以前写的代码,真是自己都不愿意看)
1.代码块
习惯将一个类中的代码分为:字段、属性、实例构造器、私有方法、公共方法、接口实现、重写基类方法、事件等等,按代码量可继续划分,方便阅读
View Code
#region 代码块 //code1 //code2 //code3 #endregion
VS快捷输入:#region+Tab
2.名称尽量有意义
类名、字段、属性名为名词,方法名为动词等等
3.注释
虽然牛B的代码可以完全用名称就解释了代码,但我没那个水平。
C#的编译器将注释处理到Xml文件中,添加后你就可以在只能提示里面看到自己的注释。
写了注释于人于己都方便,当然注释仅仅对类、方法、一些有意义的变量、属性、算法,不能无脑注释。
VS快捷输入:a.//行注释、
b./* */块注释 ,不常用
c./// XML文档注释,在类成员(方法、类等等)的上一行添加“///”,会有惊喜
4.变量和属性使用
属性给外部使用(可以用属性访问器控制),变量给内部使用。公共变量在名称前加下划线标记,局部变量照常。
View Code
#region 字段和属性 private Color[] _colors; private double _minValue; private double _maxValue; private int _visibleLabelNo = 0; private int _scale; private Font _labelFont; private Color _labelColor; private Point _colorbarLocation; private Size _colorbarSize; [CategoryAttribute("标签"), DescriptionAttribute("标签字体"), ReadOnlyAttribute(false) //,DefaultValueAttribute(new Font("宋体",10)) ] public Font LabelFont { get { return _labelFont; } set { _labelFont = value; SetLabelAttribute(_labelColor, _labelFont); } } #endregion
5.一个项目中的文件放在一个命名空间下,可以分文件夹存放
其他的暂时没想起来,想起来再加。