首页 > 代码库 > 程序员的苦闷--开发规范

程序员的苦闷--开发规范

1 背景

写代码不可避免要对函数、变量命名,而命名往往是困难的,也是开发规范的重要主题。老夫行走江湖多年,所见开发规范大多过时。

2 意外收获

而今天看到新鲜出炉Net开发规范,窃以为有很好的指导意义。虽然文中说的是C#开发,但对Java、JS等依然有足够的效用。

http://www.cnblogs.com/luzhihua55/p/CodeConvention7.html

3 不认同

但文中部分内容不为老夫所认同,如 2、4,这2个数字对应To、For,应当是常识,而非卖弄风骚

4 未解决

专业术语的命名依然是难题,如:电厂日发电计划等,目前有几种命名时,但较效果不好

a 英文命名

造成命名过长

b 中文命名

纯Net环境尚可用,但Java的IDE似乎不支持,容易引起兼容、部署问题

c 拼音全写

过长,而且部分人普通话不标准

d 拼音首字母

难懂难看,这种命名给另一项目组的人来看难于上青天,但我们目前大多采用此方法

e 代号命名

给所有的词汇都提供简短的编码,如:A01表示身份证号,B01表示养老金基数,AB表示导弹前端引信。

5 建议

针对专业术语的命名,由需求人员整理出中文的专业词汇表,然后由设计人员对语汇表进行统一命名,形成对照表。对于长期项目,可以采用代号命名法;对于短期项目,则用拼音全写。对照表需要通过开会评审以确保所有人能看得明白。命名还需要注意不要有统一的前缀,以防开发人员需要输入太多内容后,IDE的代码提示才能发挥作用。