作者 | 随笔川迹
ID | suibichuanji
前言
撰文:川川
好的代码是有生命力的,程序是写给人读的,顺便在机器上跑一下
当你在阅读别人的代码时,据说评判一个项目的好坏,就是看阅读代码人说脏话程度...:
难于理解的代码段
可能存在错误的代码段
浏览器特殊的HACK代码
业务逻辑强相关的代码
变量语句注释
针对变量中的语句注释,可以放在变量定义行和语句行的上一行,使用javaScript标准的单行注释...HANDLE_INPUT_VALUE = 'handle_input_value'
函数注释
针对某个函数的注释,必须放在函数定义行的上一行,注释内容包括:
函数功能说明,介绍该函数的功能
参数列表,...(例如,.btn 和 .btn-primary,可参考bootstrap的命名风格
Primary在github上阅读优秀的开源代码
提升自己写代码规范的档次,限于篇幅,更多内容见下篇