代码编写命名规范


正确的变量命名规范:
采用匈牙利标记法标记数据类型或者控件类型


为变量赋予表意性强的名字
例如:intIndex、dgvStudentInfo,像strTemp这样的变量名是极其令人恶心的。
尽量避免对变量名的缩写,如果必须缩写一定保证缩写后不影响对变量的理解。


变量名中混合使用大小写
例如:
-Dim strFIRSTERNAME as string与dim strlastname as string都是不规范的


使用统一的量词并放在结尾
例如:
-Dim strFirstCustomer As String
-Dim strLastCustomer As String
-Dim strPreviousCustomer As String
上面的变量定义就没有下面的变量定义更加容易理解与搜索

-Dim strCustomerFirst As String
-Dim strCustomerLast As String
-Dim strCustomerPrevious As String
我们可以通过以上几条原则来规范自己的代码使自己代码的可读性增强。


注释能使代码更加容易理解,更加容易跟踪。
出色的注释就像一幅好的设计蓝图,能够引导阅读者通过你的应用程序的曲折之处,能够说明预期的运行结果和可能出现的异常情况。
注释可以为后来的维护者带来极大的方便,无论是类说明注释,方法说明注释,还是变量说明注释,这些都是不可或缺的。没了注释代码就是“天书”,有的读者可能会说花点时间来看也不费劲嘛!
想象一下阅读类似于上文中的那样没有注释的几千,几万,几十万代码是多么费时费力的事,但是这些时间原本是可以通过几行注释节省的。

书接上回还是以上次文中的代码为例。可悲的是文中代码和大多数人写的代码一样——没有注释。
1. 写注释的人有着共同的特点,不写注释的人各有各的理由。
写注释太费时间
实际上,在编写代码时加上注释根本不需要多少时间。
有些过程很难注释。
通常而言,如果代码的一个部分很难注释,那么如果没有注释,其他人就更难理解你的代码。
PS:复杂而很难注释的代码也许不是什么好代码。
如果你发现难以给全部或者部分过程加上注释,那么请回头好好检查一下你的代码,你很可能会发现更好的解决办法。


2. 注释原则(摘录),供大家参考
不要简简单单重复代码做些什么,不能给代码增加信息的注释还不如不写。
用注释来说明何时可能出错和为什么出错,方便后期调试。
在编写代码前进行注释,以文字的形式展现你的思路。

增强注释的可读性,语句完整、表意清楚;格式上的缩进、对齐等美观操作也是不可少的。
为每个过程赋予一个注释标头,C#中的///(VB中是’’’)可以在过程调用时清楚的指导此过程的信息。

内部注释方面:
(1) 在每个if和select语句的前面加上注释,让读者语句因为什么而分支,不同的分支结果会是什么。
(3) 在每个循环的前面加上注释,保证读者明白此循环的作用。
(4) 在修改了全局变量(如果有的话)的每个语句前面加上注释,方便后期代码调试。

原文地址:https://www.cnblogs.com/sun-frederick/p/4762996.html