• 微信公众号:美女很有趣。 工作之余,放松一下,关注即送10G+美女照片!

代码命名规范

开发技术 开发技术 4小时前 2次浏览

代码规范化基本上有七大原则:

1) 空行    2) 空格    3) 成对书写   4) 缩进  5) 对齐  6) 代码行    7) 注释

另外,还需要一系列的原则,如:

良好的工程结构
目录结构要清晰,例如很多框架采用了mvc设计思想。模型放一个目录,视图放一个目录,控制器放一个目录。大家可以下载相关的mvc设计思想的框架,例如:ThinkPHP、Laravel。

使用DRY原则

不要重复你的代码。拆分可重用函数或类,使用常量定义。

使用有意义并一致命名

不要使用拼音命名,不要没有明确含义的命名。

变量命名:变量的名词性(形容词+名词),长名字可用下划线连接。

函数名:小驼峰式(如:getUserInfo())。函数的动词性(动词+形容词+名词;谓语+宾语)

类的命名:大驼峰式(如:UserInfo)类的名词性:如:OrderModel。不可出现下划线。

适当留空和必要缩进

使用tab键缩进(不可使用4个空格来代替缩进)。

留空(使用空格、换行、空行)

避免深嵌套

嵌套不应该大于3层。函数不应该有多个出口。

添加应有的注释

注释块/**/

文件头:名词,版权,作者。

类:类作用解释。

函数:函数作用,入参数,返回内容。

注释行 //:帮助记忆

代码说明:一般用于对某个逻辑块的说明。

结束提示:常用于if、switch、while逻辑体结束说明。

开发提示

调试提示

变量声明和初始化

避免声明的局部变量覆盖上一级声明的变量

使用前必须将变量初始化

变量名尽量体现数据类型

永远不要相信用户

天真的用户:只要有输入框,就会出现各种输入内容

不怀好意者:会想办法通过输入注入恶意内容

防范措施:前端对输入进行校验。后端对于输入校验必不可少,不能假设前端做了正确的校验。存在你也不知道的入口。攻击者会直接通过编造请求的方式进行提交。防止各种注入。

合理使用缓存机制

建议使用缓存机制缓存获得更好的性能。例如:redis、memcached等。

避免代码的Copy和Paste

没有理解代码的含义,就呆板的拷贝复制。拷贝来的代码未必就是对的。如果有重复代码,意味着可以拆分出一个功能函数。

尽量多使用框架
框架的目的是为了提高开发效率。框架是前辈们知识和经验积累而来,是被证明了的成熟解决方案。绝大数框架基于MVC(模型视图控制器)架构理念而开发。选择适合自己的框架。

 


程序员灯塔
转载请注明原文链接:代码命名规范
喜欢 (0)