简单的编码规范注意事项
在一个主业是扒皮的公司里干着唯一个自己的项目,没人带,没人教,自己一个人瞎做,做出来完事。没有代码规范,没有注释,全面没一个Dispose。。。
我不盼着有个大牛指导,我只想知道每个程序员都知道的东西,但是这东西很难自学,很琐碎。
所以自己总结点编码的注意事项,以供日后参考,肯定是很基础,如果您是大牛,可怜俺这悲催的小码农,也欢迎您帮助我指正,补充。万分感激!
1.注释,编码规范:
先写注释,再写代码;理清思路再动手:
(1)在一个空的函数体内用注释写出自己的思路
(2)理清思路后,在空白处填写自己的代码
(3)编完主函数后,填充空的子函数体。
2.给变量起个好名字:
(1)PascalCasing(大写开头):用于名字空间、类型、成员等的命名。
(2)camelCasing(驼峰命名法,小写开头):用于形参、局部变量、私有字段等的命名。
(3)类(结构)及对象的命名:名词或名词短语,因为它们代表系统中的实体。举例:Student student; List<Student> students。
(4)接口的命名:表示类型层次的根基时:名词或名词短语,如:IList<T>; 表示某种能力时:形容词或形容词短语,如IComparable<T>。
(5)方法的命名:动词或动词短语,DoSomething()。
(6)属性的命名:名词短语或形容词。举例:public class ListView{public ItemCollection Items {get;}}。
用肯定性短语命名布尔属性,考虑前缀“Is/Can/Has”。举例:CanRead、IsPostBack。
(7)控件的命名:可以用匈牙利命名法(小写开头,首单词为数据类型)。另外:检测代码规范的工具:FxCop。
1、2详见http://www.cnblogs.com/SummerRain/archive/2012/08/25/2656955.html
3.内存泄露相关:以我目前的水平,只需要把ApplicationContext,Brush,Component,ComponentDesigner,Container,Context,Cursor, FileStream,Font,Icon,Image,Matrix,Object,OdbcDataReader,OleDBDataReader,Pen,Regex,Socket,StreamWriter,Timer,Tooltip
等常见的非托管代码Dispose()一下即可。
3.详见http://blog.csdn.net/yuanhuiqiao/article/details/5264480 http://blog.csdn.net/zhvsby/article/details/5945038
日后再有积累再补充。