前端组件开发文档

微吼组件开发及使用规范


JS规范

<p>[TOC]</p> <h4>变量命名</h4> <hr /> <ul> <li>【 必须 】 在Babel 引入工程 ,严格杜绝Var 进行变量声明</li> <li>【 必须 】 构造函数,必须采取首字母大写。 例如: function VhallChat() { }</li> <li>【 必须 】 函数及变量命名,采取小驼峰命名规范。 例如: function helloWorld () { }</li> <li>【 必须 】 函数及变量命名,采取小驼峰命名规范。 例如: function helloWorld () { }</li> <li>【 必须 】 常量声明,采用全大写单词之间用 - 连接。 例如: const TYPE = 'clicktype'</li> <li>【 必须 】 严禁对SDK 事件在代码中进行硬编码。</li> </ul> <h4>缩进</h4> <hr /> <p>统一采用 2个空格进行缩进。 严禁 tab 缩进。</p> <h4>字符串拼接</h4> <hr /> <p>字符串 拼接统一使用 ES6 字符串模板进行拼接。 严禁 + 拼接。</p> <h4>编码风格规范</h4> <hr /> <p>【推荐】 前端工程项目。统一采用ESlint starand 进行编码风格校验。ESlint 指南。 <a href="https://standardjs.com/rules.html" title="https://standardjs.com/rules.html"><a href="https://standardjs.com/rules.html">https://standardjs.com/rules.html</a></a></p> <h4>文档DOC</h4> <hr /> <p>【推荐】 components / 目录下的,共有模块。必须用JSdoc 对方法 用途 、 参数 、 返回值 、 author 进行注释声明。 便于大家交叉review 和 维护。JSDOC 中文指南手册: <a href="https://www.html.cn/doc/jsdoc/about-namepaths.html" title="https://www.html.cn/doc/jsdoc/about-namepaths.html"><a href="https://www.html.cn/doc/jsdoc/about-namepaths.html">https://www.html.cn/doc/jsdoc/about-namepaths.html</a></a></p>

页面列表

ITEM_HTML