代码规范总结

前言       

       作为一名优秀的程序媛，最基本的代码规范那是万万不可小觑的，它体现了我们的职业操守和职业修养。

重要性

1.一个软件的生命周期中，80%的花费在于维护，代码规范降低了金钱成本和时间成本。

2.几乎没有任何一个软件，在其整个生命周期中，均由最初的开发人员来维护，代码规

范减少了工作交接过程中的交流成本。

3.规范可以改善软件的可读性，可以让程序员尽快而彻底地理解新的设计和代码，节约

了时间，提高了工作效率。

4.良好的编码规范可以有效避免一些低级错误，赢得同事的夸奖和上司的认可。

命名规范原则

• 名字应该能够标识事物的特性，并且与业务挂钩。
• 名字一律使用英文单词，而不能为拼音。
• 名字可以有两个或三个单词组成，但不应多于4个，控制在3至30个字母以内。
• 在名字中，多个单词用大写第一个字母（其它字母小写）来分隔。例如：IsSuperUser。
• 命名避免和以下关键字冲突如：Base，Date，Class……
• 方法名、参数名统一使用驼峰命名法（Camel命名法），除首字母外，其他单词的首字母大写，其他字母小写，类名每个组合的单词都要大写；正例：localValue、getHttpMessage、inputUserId

注释规范原则

•  一般情况下，源程序的有效注释量必须在30%以上。
• 避免使用装饰性内容，保持注释的简洁。
• 注释信息不仅要包括代码的功能，还应给出原因，不要为注释而注释。

单行注释：

//……

 块注释：

/*……*/

文档注释：

/**……*/

感谢阅读~