命名规范(一)

来源:互联网 发布:linux命令行设置中文 编辑:程序博客网 时间:2024/05/22 00:27

在进行机房的时候,没有学生提供的代码窗体,看到这些不知名的窗体和控件很头疼,还好有前辈留下的经验总结,解决了我的窗体控件命名的问题。但是,我就很想知道应该怎么样命名呢,这样以后遇到了其他项目也就可以自己解决了。所以,就把我的理解分享一下!


工程

在任何时候,不要使用中文命名,包括文件夹,文件名,函数名,变量名。除非文件需要和用户交互!
工程命名不必缩写,为了表达意思和用途,可以尽可能地长。

变量:

全局变量加前缀:'g_'
模块级变量加前缀:'m_'
过程级变量不加前缀

变量命名应该简单,尽量使用缩写,所有前缀都全部小写,后面的单词首字母大写

果是一般的值类型,直接使用变量用途命名,尽量使用全名:
Dim name As String
Dim count As Interger
对于一般的临时性变量定义,应该尽可能地简单
Dim i As Integer
For i = 0 to 100
Next I
如果是类对象或自定义类型对象,则在单一使用情况下使用类名称或自定义类型名称的简写来命名:
Dim pm As ProcedureManager,即:ProcedureManager缩写为pm,作为变量命名。
如果非单一使用,则使用类型名称缩写为前缀
Dim emRead As EntityManager

控件:

控件命名一律使用控件类型缩写+控件用途的命名方式,类型缩写应控制在3个字母以内,缩写规则同变量命名
空行:在函数之间必须加上空行(两行左右)
函数内部,变量声明和变量声明外的其它代码要使用空行进行间隔,(一行)。
缩进:缩进用Tab,不用空格
对于基本的控制结构,必须要有缩进,如:IF、DO、WITH、FOR、OPEN、SELECT块,
对于过长的语句,必须使用续行,续行位置要有明显意义

什么是好的代码:

1) 可读性很强的代码格式,能够区分不同的代码块
(2) 清晰明了的命名,在尽可能短的名称长度下传递足够多的信息
(3) 和代码相得益彰的注释(不要让注释重复代码所能表达的信息)
(4) 变量的生存期尽可能地短,这样阅读者不用去记大量的变量声明
(5) 使用小函数,将功能复杂的大函数进行分隔
总之,代码的好坏应该让别人是否能够容易读懂来区分,如果对自己的代码不满意,那么先给别人阅读,然后让阅读者告诉你他为什么读不懂,哪些地方读着吃力。好的代码应该能够让你在几个月后回顾自己的代码时一目了然

原创粉丝点击