代码编写 四个要点

美观：

 

还记得刚进一家公司时让我改某个人的代码，我当时疯了，代码乱七八糟，我根本就不想看那些代码，怎么去改。

人靠衣装，就算你再有钱再有学识，穿着不好我只能当你是要饭的。写代码也是一样，面对横七竖八乱乱糟糟的代码，反胃的心都有了，怎么去看你的代码。

所以代码的美观度和重要，当然你也没必要刻意去做代码的美观（虽然我经常这么干），但是就像传衣服一样，你不传正装不传礼服，最起码不能穿着没洗过而且破漏的衣服吧。

我还是建议，当你写完自己的代码，花一些时间去格式化和手动美化一下你的代码，一来休息一下二来欣赏一下自己的作品，也许在这个工作中还会发现一些BUG，大家都高兴的事情，何乐而不为？ 

 

 

注释：

 

我有这样一个感觉，如果我看一个人的代码却没有注释，首先会感觉到没有安全感。

可能是大家有时候写代码时间过于紧张，而会忽略这些问题但是如果你不注意，可能下个星期你自己连自己的代码都搞不清楚了（至少我有过这样的情况）。

注释是个好东西呀，大家都懂的，只是执行力的问题。

另外代码的注释一定不要累赘，要看见就知道是什么意思。

也不要觉得简单的问题就不写注释，不统一的注释反正我看着是不舒服。

 

 

风格：

 

代码风格涉及的东西还是挺多的，一时也不好说是那些

就是两个人在实现和代码美观上的一致性，比如同样的一个增加查询而你的SQL是拼装的有的是参数传递。再比如我喜欢每个方法都有注释而你只是重点方法有。再比如我的代码分两层而你的代码分三层。

很简单，如果你看这个人的代码和看另外一个人代码没有太大区别，那说明他们的风格是一致的。如果你一眼就看出来不是一个人写的，那就有问题了。

每个公司都有自己的要求，但是公司要求不是每个人都去执行的，另外没必要刻意要求员工必须怎么样做，在不脱离规则的情况下，实现功能完成工作才是最重要的。 

 

 

构想：

 

 你代码怎么实现的对于安全性，效率问题，和别人使用就会有影响。

所以再写一个模块的代码之前，你首先要有至少五分之一的考虑时间。一个系统要开发，调研很重要，那么一些代码要开发，思考就不重要吗？拿到需求就去写，别人同样功能会怎么做，会不会和别人产生交叉，中途会不会因为技术和其他问题而耽误。

一个不会思考的人是不会写出好代码的。

我们不能把写代码仅仅作为一项工作去做，如果只是工作，那完成任务就行了。我们要当作一项乐趣，一项自己的成就，所以要在各个方面去思考着完成它，而不是仅仅为了时间就仓促任意去做。

 

请您到ITEYE看我的原创：http://cuisuqiang.iteye.com

或支持我的个人博客，地址：http://www.javacui.com

 

评论

15 楼 jiangwenxian 2013-03-12  

jinnianshilongnian 写道

cuisuqiang 写道

jinnianshilongnian 写道

cuisuqiang 写道

windcloudno1 写道

说的挺好，请别有错别字。

我要是语文老师，绝对不会有，呵呵呵

即使你是语文老师 也可能有 世事无绝对

伤死我了你

哈哈 

14 楼 jinnianshilongnian 2012-08-20  

cuisuqiang 写道

jinnianshilongnian 写道

cuisuqiang 写道

windcloudno1 写道

说的挺好，请别有错别字。

我要是语文老师，绝对不会有，呵呵呵

即使你是语文老师 也可能有 世事无绝对

伤死我了你

哈哈 

13 楼 cuisuqiang 2012-08-20  

hudepin 写道

风云无浪 写道

函数尽量不要超过五十行，同样功能的代码和有意义的常量，不要出现两次

为什么是50行，发现我写的有的都超过100行了

凡事无绝对

12 楼 cuisuqiang 2012-08-20  

lovexp2010 写道

我觉得第一要点是正确性。比如这段代码能否正确表达这段逻辑，能否覆盖所有的case，脱离这一点，其他都浮云~~~

这是最基本的要求

11 楼 cuisuqiang 2012-08-20  

jinnianshilongnian 写道

cuisuqiang 写道

windcloudno1 写道

说的挺好，请别有错别字。

我要是语文老师，绝对不会有，呵呵呵

即使你是语文老师 也可能有 世事无绝对

伤死我了你

10 楼 hudepin 2012-08-20  

风云无浪 写道

函数尽量不要超过五十行，同样功能的代码和有意义的常量，不要出现两次

为什么是50行，发现我写的有的都超过100行了

9 楼 lovexp2010 2012-08-20  

我觉得第一要点是正确性。比如这段代码能否正确表达这段逻辑，能否覆盖所有的case，脱离这一点，其他都浮云~~~

8 楼 jinnianshilongnian 2012-08-20  

cuisuqiang 写道

windcloudno1 写道

说的挺好，请别有错别字。

我要是语文老师，绝对不会有，呵呵呵

即使你是语文老师 也可能有 世事无绝对

7 楼 cuisuqiang 2012-08-20  

jinnianshilongnian 写道

风格关键是有套合约限制，否则我随时可能乱来（比如心情不爽的时候），比如选择checkstyle。

要有一定的规范框架，但是又不能过度细节化

6 楼 cuisuqiang 2012-08-20  

windcloudno1 写道

说的挺好，请别有错别字。

我要是语文老师，绝对不会有，呵呵呵

5 楼 cuisuqiang 2012-08-20  

风云无浪 写道

函数尽量不要超过五十行，同样功能的代码和有意义的常量，不要出现两次

代码行数确实是个问题，但是往往为了实现，我们都是一脑子股用一个方法把一个功能实现了。为了实现第四个说的代码构想，写完代码可以抽取一下方法！

4 楼 windcloudno1 2012-08-20  

说的挺好，请别有错别字。

3 楼 jinnianshilongnian 2012-08-20  

  

2 楼 jinnianshilongnian 2012-08-20  

风格关键是有套合约限制，否则我随时可能乱来（比如心情不爽的时候），比如选择checkstyle。

1 楼 风云无浪 2012-08-20  

函数尽量不要超过五十行，同样功能的代码和有意义的常量，不要出现两次