主题:[原创]分享下我编程的代码规范
熟悉我的人都知道,我是习惯“裸奔开发”的完美主义Coder,也就是不借助任何框架或者插件,我实现的功能,除非是时间不允许,否则一定是我用代码一个一个敲出来、一行一行的堆起来的。因此我的代码规范也绝对不是模仿别人的,而是在长年累月的编程工作中,自己总结出来的经验。以下以我最熟悉的VB为例:
1、采用英文
大部分语言只支持用字母编程(其实VB也可以用中文做变量名!),但采用中文是种非常不科学的做法,因为涉及到字符集、跨平台等诸多问题,所以坚决杜绝使用。那么采用拼音可以吗?我觉得也不可取,因为拼音的简写实在太飘逸,比如一个“SB”,你只会联想到“傻X”,而不会联想到“上班”、“顺便”、“随便”等,如果用“Shab”或者“Sbi”作为简写,那将会更匪夷所思,拼音基本上无法使用简写,所以我提倡用英文,因为英文在使用简写的时候,基本不会产生歧义,除非你让它有了产生歧义的可能。
2、关于简写
英文简写实际上是一门学问,首先你得简,而且必须是最简程度,但同时又必须让人(地球人)能猜出意思。所以这里有个很严重的问题,很多人在简写英文的时候,过于追求“简”,导致了只有自己猜出得意思,而别人猜不出意思,乃至于过了几个月后甚至仅仅几天后,自己都猜不出来了,这很恶搞,是种失败的简写行为,因此希望引起大家的注意。我的简写规律是,较短的单词直接使用全部字母,如:pig;较长的单词尽可能的利用单词中的辅音字母和元音字母来组成和原单词发音接近的简写,如,:password(pwd);多个单词组合的,前面几个尽量简,最后一个尽量全,如:Sort Id(sid);最重要的一点就是,尽量少用,能不用就不用,编程中常见的保留单词,这个习惯必须保持,因为不同的语言里面有不同的保留词,如:long、float、echo等等。
3、命名规则
常量:全部大写,多个单词用下划线隔开PIG
BLACK_PIG
BLACK_FAT_PIG
复制代码变量:全部小写,多个单词用下划线隔开pig
black_pig
black_fat_pig
复制代码函数:驼峰式,以名词开头,以动词结尾
function newsAdd()
*代码
end function
function newsEdit()
*代码
end function
function newsDelAll()
*代码
end function
复制代码类:首字母大写式,最好只用名词(因为我类的属性一般用形容词,方法一般用动词)
class Pig
*代码
class JimPig
*代码
class JimDogPig
*代码
复制代码OK,就先说这么多了,我的注释规范等哪天有空再说吧,毕竟只是个人习惯,围观下就好,其实编程没什么捷径,就是多写代码多看代码,像VBGOOD、CSDN上的牛人代码(AD一下偶的站:.[url=http://www.oldcode.cn]老代码-编程函数精华-个人代码收藏夹[/url]
当初自己为了收集代码方便,就建了这个站,朋友们有兴趣也可以在上面收藏一些平时自己用的代码),多做项目,一个合格的程序员是经过长期的技术、思维沉淀下来形成的,任何东西速成貌似都是有缺陷的(现在社会太疯狂,太浮躁,最BS什么从入门到精通、什么大全的书,一本书都能搞定,全民都成程序员了,发下牢骚)也欢迎大家批评指正
1、采用英文
大部分语言只支持用字母编程(其实VB也可以用中文做变量名!),但采用中文是种非常不科学的做法,因为涉及到字符集、跨平台等诸多问题,所以坚决杜绝使用。那么采用拼音可以吗?我觉得也不可取,因为拼音的简写实在太飘逸,比如一个“SB”,你只会联想到“傻X”,而不会联想到“上班”、“顺便”、“随便”等,如果用“Shab”或者“Sbi”作为简写,那将会更匪夷所思,拼音基本上无法使用简写,所以我提倡用英文,因为英文在使用简写的时候,基本不会产生歧义,除非你让它有了产生歧义的可能。
2、关于简写
英文简写实际上是一门学问,首先你得简,而且必须是最简程度,但同时又必须让人(地球人)能猜出意思。所以这里有个很严重的问题,很多人在简写英文的时候,过于追求“简”,导致了只有自己猜出得意思,而别人猜不出意思,乃至于过了几个月后甚至仅仅几天后,自己都猜不出来了,这很恶搞,是种失败的简写行为,因此希望引起大家的注意。我的简写规律是,较短的单词直接使用全部字母,如:pig;较长的单词尽可能的利用单词中的辅音字母和元音字母来组成和原单词发音接近的简写,如,:password(pwd);多个单词组合的,前面几个尽量简,最后一个尽量全,如:Sort Id(sid);最重要的一点就是,尽量少用,能不用就不用,编程中常见的保留单词,这个习惯必须保持,因为不同的语言里面有不同的保留词,如:long、float、echo等等。
3、命名规则
常量:全部大写,多个单词用下划线隔开PIG
BLACK_PIG
BLACK_FAT_PIG
复制代码变量:全部小写,多个单词用下划线隔开pig
black_pig
black_fat_pig
复制代码函数:驼峰式,以名词开头,以动词结尾
function newsAdd()
*代码
end function
function newsEdit()
*代码
end function
function newsDelAll()
*代码
end function
复制代码类:首字母大写式,最好只用名词(因为我类的属性一般用形容词,方法一般用动词)
class Pig
*代码
class JimPig
*代码
class JimDogPig
*代码
复制代码OK,就先说这么多了,我的注释规范等哪天有空再说吧,毕竟只是个人习惯,围观下就好,其实编程没什么捷径,就是多写代码多看代码,像VBGOOD、CSDN上的牛人代码(AD一下偶的站:.[url=http://www.oldcode.cn]老代码-编程函数精华-个人代码收藏夹[/url]
当初自己为了收集代码方便,就建了这个站,朋友们有兴趣也可以在上面收藏一些平时自己用的代码),多做项目,一个合格的程序员是经过长期的技术、思维沉淀下来形成的,任何东西速成貌似都是有缺陷的(现在社会太疯狂,太浮躁,最BS什么从入门到精通、什么大全的书,一本书都能搞定,全民都成程序员了,发下牢骚)也欢迎大家批评指正