代码编写规范[转载]

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);
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
【社区内容提示】社区部分内容疑似由AI辅助生成,浏览时请结合常识与多方信息审慎甄别。
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

相关阅读更多精彩内容

  • 随着代码量的增加和项目的增大以及项目合理或不合理的迭代,代码会显得冗余和杂乱。良好的代码规范和和规则以及设计良好的...
    大刘阅读 3,297评论 0 4
  • 0. 写在前面 当你开始工作时,你不是在给你自己写代码,而是为后来人写代码。 —— Nichloas C. Zak...
    康斌阅读 10,752评论 1 42
  • 本文从Java代码编写的初期到结尾,做了一次整体的总结,希望对初学者有帮助。 一个错误的命名会很误导人,不良的命名...
    小宇java阅读 3,821评论 0 1
  • 所谓屋檐太寂静,一场夜雨 吵不过半秒油炸的水声 顷刻间立场倒下,褐色砖石在清明 东倒西歪,摇摇晃晃需要琅玕防护 湖...
    行吟诗人小Tom阅读 1,855评论 1 1
  • 1、我不喜欢你,你,还有你:-D。2015.04.03.13:50 2、写下这句话的时候我正在上班嘻嘻。2015....
    耳咚贰号阅读 1,369评论 0 1

友情链接更多精彩内容