MyException - 我的异常网
当前位置:我的异常网» 研发管理 » 代码整洁之道-定名

代码整洁之道-定名

www.MyException.Cn  网友分享于:2013-12-04  浏览:0次
代码整洁之道--命名

整洁的代码只做一件事

优雅的代码

外表或者举止上令人愉悦的优美和雅观,令人愉悦的精致和简单

 

命名

名副其实,

避免误导

做有意义的区分

使用读的出来的名称

使用可搜索的名称  长名称胜宇短名称,搜得到的名称胜宇自造的名称

避免使用编码

 

匈牙利命名法:(不要)

由于在过去数据类型都是弱类型的,那时候编译器并不做类型检查,程序员需要匈牙利语标记法来帮助自己记住类型。

JAVA不需要类型编码就,对象是强类型的,现在编辑环境在编译开始前就可以侦测到类型错误,如果还用匈牙利命名法,会增加阅读代码的难度。

 

成员前缀(不要)

没有必要增加前缀和后缀这些废料,这些已经变成旧代码的标志

 

接口和实现

接口命名去掉废字母I,实现增加Imp

 

避免思维映射

明确是王道,编写其他人能理解的代码。

 

类名

类名和对象名应该是名称或名词短语,类名不应当用动词

 

方法名

方法名应当是动词或动词短语。

 

重载构造器时,使用描述了参数的静态工厂方法名

例如:

Complex fulcrumPoint = Complex.FromRealNumber(23.0);

通常好于

Complex fulcrumPoint =new Complex(23.0);

 

别扮可爱

别用笑话或者俚语

言到意到,意到言到。

 

每个概念对应一个词

给每个抽象概念选一个词,并且一以贯之i

 

别用双关语

避免同一单词用于不同目的

 

使用解决方案领域名称

只有程序员才会读代码,所以,尽管用计算机科学术语,算法名、模式名、数学术语。

使用解决方案领域名称,不要使用问题所涉及到领域来命名,增加阅读者对业务理解的负担。

 

使用源自所涉问题领域的名称、

如果不能用程序员熟悉的术语来给手头的工作命名,就采用从所涉问题领域而来的名称,至少,负责维护代码的程序员可以去请教领域专家。

 

优秀的程序员和设计师,其工作之一就是分离解决方案领域和问题领域的概念。

与所涉问题领域更加贴近的代码,应当采用源自问题领域的名称。

 

添加有意义的语境

 

不要添加没用的语境

只要短名称足够清楚,就要比长名称好,别给名称添加不必要的语境

 

取好名字最难的地方在于需要良好的描述技巧和共有文化背景

与其说这是一种技术、商业或管理问题, 还不如说是一种教学问题,其结果是,这个领域内的许多人都没能学会做的很好。

充分利用重构的工具,能用更好的名字就用更好的名字。

 

文章评论

如何成为一名黑客
如何成为一名黑客
十大编程算法助程序员走上高手之路
十大编程算法助程序员走上高手之路
编程语言是女人
编程语言是女人
程序员眼里IE浏览器是什么样的
程序员眼里IE浏览器是什么样的
10个调试和排错的小建议
10个调试和排错的小建议
老美怎么看待阿里赴美上市
老美怎么看待阿里赴美上市
初级 vs 高级开发者 哪个性价比更高?
初级 vs 高级开发者 哪个性价比更高?
“肮脏的”IT工作排行榜
“肮脏的”IT工作排行榜
5款最佳正则表达式编辑调试器
5款最佳正则表达式编辑调试器
“懒”出效率是程序员的美德
“懒”出效率是程序员的美德
每天工作4小时的程序员
每天工作4小时的程序员
我是如何打败拖延症的
我是如何打败拖延症的
程序员必看的十大电影
程序员必看的十大电影
一个程序员的时间管理
一个程序员的时间管理
那些性感的让人尖叫的程序员
那些性感的让人尖叫的程序员
程序员的鄙视链
程序员的鄙视链
60个开发者不容错过的免费资源库
60个开发者不容错过的免费资源库
为啥Android手机总会越用越慢?
为啥Android手机总会越用越慢?
我跳槽是因为他们的显示器更大
我跳槽是因为他们的显示器更大
旅行,写作,编程
旅行,写作,编程
程序员周末都喜欢做什么?
程序员周末都喜欢做什么?
什么才是优秀的用户界面设计
什么才是优秀的用户界面设计
老程序员的下场
老程序员的下场
团队中“技术大拿”并非越多越好
团队中“技术大拿”并非越多越好
程序员最害怕的5件事 你中招了吗?
程序员最害怕的5件事 你中招了吗?
Java 与 .NET 的平台发展之争
Java 与 .NET 的平台发展之争
2013年美国开发者薪资调查报告
2013年美国开发者薪资调查报告
看13位CEO、创始人和高管如何提高工作效率
看13位CEO、创始人和高管如何提高工作效率
Web开发者需具备的8个好习惯
Web开发者需具备的8个好习惯
总结2014中国互联网十大段子
总结2014中国互联网十大段子
Java程序员必看电影
Java程序员必看电影
那些争议最大的编程观点
那些争议最大的编程观点
Web开发人员为什么越来越懒了?
Web开发人员为什么越来越懒了?
要嫁就嫁程序猿—钱多话少死的早
要嫁就嫁程序猿—钱多话少死的早
Google伦敦新总部 犹如星级庄园
Google伦敦新总部 犹如星级庄园
程序猿的崛起——Growth Hacker
程序猿的崛起——Growth Hacker
程序员都该阅读的书
程序员都该阅读的书
10个帮程序员减压放松的网站
10个帮程序员减压放松的网站
不懂技术不要对懂技术的人说这很容易实现
不懂技术不要对懂技术的人说这很容易实现
聊聊HTTPS和SSL/TLS协议
聊聊HTTPS和SSL/TLS协议
科技史上最臭名昭著的13大罪犯
科技史上最臭名昭著的13大罪犯
为什么程序员都是夜猫子
为什么程序员都是夜猫子
代码女神横空出世
代码女神横空出世
我的丈夫是个程序员
我的丈夫是个程序员
漫画:程序员的工作
漫画:程序员的工作
中美印日四国程序员比较
中美印日四国程序员比较
亲爱的项目经理,我恨你
亲爱的项目经理,我恨你
程序员的一天:一寸光阴一寸金
程序员的一天:一寸光阴一寸金
2013年中国软件开发者薪资调查报告
2013年中国软件开发者薪资调查报告
软件开发程序错误异常ExceptionCopyright © 2009-2015 MyException 版权所有