程序设计与开发中函数方法及变量命名规范
2007-07-03 23:17
495 查看
文章作者:Bink
鉴于目前有朋友( 并非单只邪八上这个朋友,其实网络上这样的人非常多 )在程序编写时不注意函数、方法及变量的命名导致程序的阅读与后期维护变的不是那么的容易,而且代码也很不工整,当然我这里只是描述出自己的函数方法及变量的命名方式,以供参考。
ASP 程序为例子,VB JAVA PHP C C# 等类似。
一般来说,如果不是大型程序,只是单一的功能性的代码设计框架大体如下:
Call doInit() '初始化一些全局变量
Call doLoad() '程序载入与全局变量的判断
Call doParse() '开始主程序执行
程序中用于执行的方法类似上面的命名前面用 do 加上操作名称;
程序中用于转换的函数用 to 加上要转换成的类型或者表达方式的名称,比如 toLen ,转换为长度,我们知道汉字的字节长度用 len 进行判断时会出现BUG,所以自己写了 toLen 可以在转换中计算汉字长度;
程序中用于获得某数据或者结果的函数用 get 加上数据名,比如我们要获得数据库中注册用户总数,可以写一个 getUserTotal() 的函数;
程序中用于设置某个全局或者局部变量值的方法用 set 加变量名称,比如我们用前面的 get 出一个网站的当前用户数量后可以用 setUserTotal 更新网站配置中的用户总数纪录字段。
上面是函数方法命名,然后再说变量。
很简单,变量如果在 Sub Function 等字过程中则变量名称前面加 tmp 表示该变量只临时存在于某个字过程中,比如用户名 tmpUsername 用户密码 tmpPassword ,很多人习惯了 username password 等方式,其实是不对的,这样的不带前缀的命名应该是一个局部的变量命名,而全局的变量命名就又不一样了,全局变量的命名则把变量全部大写,而且前缀是变量的作用域加下划线再加变量名,比如控制网站是否启用的变量名为 WEB_ISOPEN 这样。
好了,就这样。呵呵,这些只是我的命名方式,以此或者类似这样的命名方式的程序我自己看起来都觉得特别熟悉。
鉴于目前有朋友( 并非单只邪八上这个朋友,其实网络上这样的人非常多 )在程序编写时不注意函数、方法及变量的命名导致程序的阅读与后期维护变的不是那么的容易,而且代码也很不工整,当然我这里只是描述出自己的函数方法及变量的命名方式,以供参考。
ASP 程序为例子,VB JAVA PHP C C# 等类似。
一般来说,如果不是大型程序,只是单一的功能性的代码设计框架大体如下:
Call doInit() '初始化一些全局变量
Call doLoad() '程序载入与全局变量的判断
Call doParse() '开始主程序执行
程序中用于执行的方法类似上面的命名前面用 do 加上操作名称;
程序中用于转换的函数用 to 加上要转换成的类型或者表达方式的名称,比如 toLen ,转换为长度,我们知道汉字的字节长度用 len 进行判断时会出现BUG,所以自己写了 toLen 可以在转换中计算汉字长度;
程序中用于获得某数据或者结果的函数用 get 加上数据名,比如我们要获得数据库中注册用户总数,可以写一个 getUserTotal() 的函数;
程序中用于设置某个全局或者局部变量值的方法用 set 加变量名称,比如我们用前面的 get 出一个网站的当前用户数量后可以用 setUserTotal 更新网站配置中的用户总数纪录字段。
上面是函数方法命名,然后再说变量。
很简单,变量如果在 Sub Function 等字过程中则变量名称前面加 tmp 表示该变量只临时存在于某个字过程中,比如用户名 tmpUsername 用户密码 tmpPassword ,很多人习惯了 username password 等方式,其实是不对的,这样的不带前缀的命名应该是一个局部的变量命名,而全局的变量命名就又不一样了,全局变量的命名则把变量全部大写,而且前缀是变量的作用域加下划线再加变量名,比如控制网站是否启用的变量名为 WEB_ISOPEN 这样。
好了,就这样。呵呵,这些只是我的命名方式,以此或者类似这样的命名方式的程序我自己看起来都觉得特别熟悉。
相关文章推荐
- 数据结构:(更新中)成员变量、成员函数和实例一般命名和定义方法
- jni java类中本地方法 对应 C/C++中的函数命名规范
- Java语言中,包名、类名、接口名、方法名、变量名,以及常量名的命名有何规范的命名习惯
- Java项目开发规范之方法命名规范
- IOS开发过程中的变量命名规范和图片及切图命名规范
- 编程规范之变量命名方法
- (2)JAVA 变量 作用域 main方法 命名规范
- 【Android习惯】文件、方法、变量命名规范参考(编辑中)
- C语言 变量和函数命名规范
- 浅析C 语言变量和函数命名规范
- java命名规范,action中变量写了getset方法,页面取不到值
- java中类名,方法,变量,包名等大小写命名规范
- 让你提前认识软件开发(7):变量及函数的命名
- Java 类、方法、属性、变量、包名 等相关命名规范总结
- 『转』 函数、变量命名方法
- 笨方法学习Python-习题18: 命名、变量、代码、函数
- C语言变量和函数命名规范
- 关于C语言变量和函数命名规范
- java开发中变量命名的规范
- C语言变量和函数命名规范