项目规范（待完成）

写在前面：

　　最近冥想的时候做了一些反思，我时常忽视代码质量和基本代码规范来获取更快的实现速度，随着项目二次功能推进的时候，我不得不从新去复读之前的代码，甚至，有时候我会因某处没有备注或者前缀注释而卡停，这使得我重构功能组件函数等等，明显带来了很多不必要的麻烦。所以，想借此次反省与认识，总结一些基本的书写规范与建议。（本文较适合初学者）

 

1）提前写好注释：

　　无论是前后端，都要保持写注释的习惯。自身前端而言，写函数时提前定义接受参数类型和返回类型，并且对方法写一点备注，这样方便开发过程中去调用的时候，鼠标移动到方法可以看到各种参数类型，同时也方便后期根据备注和参数，不用管代码之前写了什么，尽管传入参数即可。

　　

/**
 * @description 对小明的问候语
 * @requires module:moduleName
 * @param {string} text - 对话文字
 * @return {string} 返回一段问候语
 */
function greeting (text) {
    return `你好小明，${text}`
}

　　以上代码可以见得：

• @description  对这个方法的一段阐述
• @requires  对于某个模块需要依赖的模块做记录
• @param  方法需要传入的参数，以 [类型] 参数 - 描述 作为格式
• @returns 可以注明返回类型，并且做一段阐述

 

 2）更好的命名方式：

　　无论何种命名方式，目的都是为了能够显而易见地表达其功能形态，达到见名知意的效果。可事实总是比我们来的更复杂，随项目不断成长，各种各样的文件、html结构、组件、函数等等，这会让整个项目从总体上失去条理性，不利于更好的总览和见名知意的效果。所以，在最初我们应该对项目有个大致的命名规范并且坚持去遵守它。

• 文件：文件名称可以使用驼峰式命名法，开头小写，当然，目录推荐是全部小写。（ 二次封装业务组件的时候，在当前写的模块下创建一个新的目录，然后把业务组件写在新目录中，这样page总目录下，形成各个模块，而总目录组件库已经是抽离出去的组件就不再与业务组件参杂在一起 ）
• html：

　　　　①  标签语义化，使得大体结构清晰明了

　　　　②  选择器命名格式 class="xxx-xx-x" ，各个名称之间使用连字符

　　　　③  选择器命名不允许开头使用数字！错误示例比如： class="666-content"

　　　　④  选择器命名最好不要使用各种常见的属性（长度、颜色、位置）名称，它应该是一个具体名称，使得可以见名知意，

　　　　　  较好的示例比如：class="card-title"，那么，我们可以知晓这是卡片的标题

• 组件：

　　　　①  文件名称应该是2-3个单词组成，并且具有可读性意义；即不过抽象也不过具体

　　　　②  在模板中，按照自定义元素规范，组件名称间使用连字符 ( - ) 分隔，同上 html 中 class 命名格式，

　　　　　  还有勿使用保留字（ " int "、" export "、" debugger " 等等 ）

　　　　③  建议性：通用组件可以使用 " app- " 前缀作为命名空间；好处是：一不会与其他组件命名冲突

　　　　　  二方便使用区别其他组件有利于特殊情况下组件嵌套（一般不推荐组件嵌套）。

•  CSS：