代码编写注意事项

如何写出好代码，这个是一个值得考虑的问题。怎样才能写出即可读又高效的代码呢？ 本文从编
码的细微处入手，总结如何写出质量高的代码。本文的观点只是一家一言，欢迎大家一起讨论。
高质量的代码一定是可读性高的，如何让代码可读性高
一） 代码文件位置
好的代码要先找对代码的存放位置，比如inc就要放头文件，src就要存放源代码文件。不要A功

能的目录存放了B功能的文件。
二） 命名
这个命名包含 文件夹命名、代码文件命名、函数命名、变量命名。
常见的命名方式有驼峰，有划线方式，匈牙利命名法、帕斯卡（pascal）命名法，如何选择：
1）如果是基于现有代码开发的话，现有什么命名方式那么就要用什么命名方式
2）如果是从无到有的新项目，那么使用什么语言，就采用该语言的常用命名方式，比如C语言，

一般使用下划线命名方式多一点。Java采用帕斯卡（pascal）命名法多一些。
还有全局变量和局部变量的命名，全局一般使用大写方式，局部的话使用小写
函数的命名，有的语言使用__下表示内部函数，C/Python都有这种应用
像 i j k这样的一般都是在循环中，ret表示返回值，这些都是约定俗成的规则。
三）函数
one function do one thing，尽量将一个功能封装成一个函数，函数能复用就复用。
函数返回值要有意义，C语言一般0表示返回成功，负数表示返回fail，每个返回值要有明确意义

这样的话便于调用者判断。
四） 格式
比如从C的经验上来，单行不能超过80个字符。TAB空格不能混用,推荐使用空格，至于空2格还是

空4格视环境和语言而定。
五） debug Log信息
好多人喜欢将debug信息放到代码中。建议将error log保留，debug log设置成可开启方式，默认

关闭，比如通过配置log等级参数方式。这种一般适合底层开发
比如在上层的开发中，往往需要一些运行信息以便检测运行状态，这种的话保留info信息，debug

信息的话在正式发布是要关闭。
六) 编译的一致性
代码最好要对编译保持一致性，这样保证在代码未修改时，每次编译得到的行为都是相同的。保持

编译的一致性，像DATE, TIME这些干扰编译结果的尽量不用。
七）尽可能代码复用
比如如果语言有相关库函数实现的话，不要自己造结构体，简单的原因是库中的代码质量是保证

的，自己实现的话bug的几率会高。
比如语言中已经实现了List vector hashmap等，不要自己重复造轮子。
八） 设计模式使用
对于面向对象的开发，能使用成熟的设计模式尽量使用成熟的设计模式，这样易于后期扩展。
九） 注释
最好的代码就是注释，如果代码不能很好的解释的话，那么就要添加注释。
对于那些注释可以用，那些不能用，可以参考谷歌的一片文章

https://testing.googleblog.com/2017/07/code-health-to-comment-or-not-to-comment.html
十） 代码执行效率考虑
虽然当前CPU的性能越来越好，但是对于编码过程中适当的效率考虑也是必要的。
十一） 逻辑简单
不要嵌套好多if else，尽量简化逻辑清晰，便于维护。