个人管理 - 什么是好代码
2010-01-07 22:09
155 查看
公司今年的技术年会设置了一个最佳代码奖,主要是从提交的代码中评选出最好的,但到底好代码的评价有哪些维度呢?工作也多年了,代码也写过很多了,自己的代码也就一般吧,以前还真没有太多想“什么是好代码”这个问题。本篇把我知道的先罗列一些,也希望大家补充。代码好坏更多的是由写代码的人来控制,所以我也把它归为个人管理系列中。
代码规范,命名和排版遵守统一的规范
没有拼错的单词
在不同地方对类似意思的代码统一命名,如不会一个地方使用add,另一个地方使用insert
采用一致的简写规则,不会有的地方简写,有的地方又不简写
是否简单,不需要想什么就能明白代码含义
对性能有要求,写出来的代码是否满足性能要求
不需要镀金,是否客户需要的功能
DRY: Don’t repeat yourself,没有重复代码
写短方法,这样易读、易重用、易测试
对类、方法和变量使用好的命名,最好直接从命名就能知道含义
单一职责,每个类只做自己的事
代码物理组织:目录、命名空间、包,把代码存储在一个容易找到的地方
代码逻辑组织:代码按逻辑访问,如层、服务
对复杂代码有对应的单元测试代码
好的代码可以通过不断重构而来
注释是有害的,尽量写可读代码。如果却是要写注释,需要在合适地方把注释写清楚
是否可以很好的适应改变
欢迎转载,转载请注明:转载自周金根 [ http://zhoujg.cnblogs.com/ ]
代码规范,命名和排版遵守统一的规范
没有拼错的单词
在不同地方对类似意思的代码统一命名,如不会一个地方使用add,另一个地方使用insert
采用一致的简写规则,不会有的地方简写,有的地方又不简写
是否简单,不需要想什么就能明白代码含义
对性能有要求,写出来的代码是否满足性能要求
不需要镀金,是否客户需要的功能
DRY: Don’t repeat yourself,没有重复代码
写短方法,这样易读、易重用、易测试
对类、方法和变量使用好的命名,最好直接从命名就能知道含义
单一职责,每个类只做自己的事
代码物理组织:目录、命名空间、包,把代码存储在一个容易找到的地方
代码逻辑组织:代码按逻辑访问,如层、服务
对复杂代码有对应的单元测试代码
好的代码可以通过不断重构而来
注释是有害的,尽量写可读代码。如果却是要写注释,需要在合适地方把注释写清楚
是否可以很好的适应改变
欢迎转载,转载请注明:转载自周金根 [ http://zhoujg.cnblogs.com/ ]
相关文章推荐
- 交流一下大家都用什么代码管理工具?每人写一个过程,10万个人就有10万个功能,无比强大****
- 个人管理 - 什么是好代码
- git管理代码个人总结(Mac不用配置环境变量的,Windows需要配置环境变量)
- 了解更多:什么是个人知识管理?
- 个人代码版本管理的好帮手--Git 基础知识
- 使用TortoiseSVN管理个人文档代码
- 可重用代码段管理器VS插件版5.0发布(代码段收集器、个人代码库、代码管理)
- 百度云网盘 360云盘 金山快盘 等 + Git GUI 实现代码版本管理-个人篇
- 简介GitHub的使用方法--管理个人代码
- 用 subversion 个人资料代码管理
- 陈灯可重用代码段管理器VS插件版5.0发布(代码段收集器、个人代码库、代码片段管理、代码管理)
- 百度云网盘 360云盘 金山快盘 等 + Git GUI 实现代码版本管理-个人篇
- 陈灯可重用代码段管理器VS插件版5.0发布(代码段收集器、个人代码库、代码片段管理、代码管理)
- 了解什么是版本控制 & 用tortoiseSVN 建立本地版本库来管理自己的代码
- 个人知识管理能解决什么问题?
- 没有个人知识管理就是觉得学了很多,却不得记到底学到了什么。
- Java web项目 个人资金项目管理系统用户部分代码
- 个人代码管理--svn
- 个人代码记录-学生社团管理
- 分享一款不错的个人代码个人知识管理软件wiz,程序员必须滴