代码编写规范[转载]

2018-11-20  本文已影响0人  霜序五

JavaScript 语言的代码编写规范,请直接看这里。--转载

其他语言的代码编写规范如下:

  1. 命名用驼峰或者下划线命名法

  2. 变量名、函数名不能使用简称,需要使用全称,不能用拼音,尽量用标准的英文单词

  3. 变量名称,函数名要语义化,尽量见名知意

  4. 每个函数不能够超过 10 行,如果超过 10 行,需要进行拆分(代码行不包括注释和但有一个花括号的行)

  5. 用注释把代码思路数写出来

  6. 代码缩进用 4 个空格

  7. 不对外提供的方法写成私有方法

  8. 多用实例方法,少用类方法

  9. 抽出 foreach(for)中的 foreach(for)方法,不要多循环嵌套,如果有的话内层循环分装成函数

  10. 代码中不要出现魔法数字

例如:

function log($level, $message) {}

在调用的时候 不要用

$log_message = 'this is a log';

log(1,$log_message);

而要用

const ERROR_LOG = 1;

log(ERROR_LOG,$log_message);
上一篇下一篇

猜你喜欢

热点阅读