代码注释在一个项目的后期维护中显的尤为重要，所以我们要为每一个被复用的组件编写组件使用说明，为组件中每一个方法编写方法说明。 ~~~ 1.公共组件使用说明 2.各组件中重要函数或者类说明 3.复杂的业务逻辑处理说明 4.特殊情况的代码处理说明,对于代码中特殊用途的变量、存在临界值、函数中使用的hack、使用了某种算法或思路等需要进行注释描述 5.注释块必须以/**（至少两个星号）开头**/； 6.单行注释使用//； ~~~ 单行注释 ~~~ 普通方法一般使用单行注释 // 来说明该方法主要作用 （放在语句右边而不是上边） ~~~ 多行注释 ~~~ 组件使用说明，和调用说明 <!--公用组件：数据表格 /** * 组件名称 * @module 组件存放位置 * @desc 组件描述 * @author 组件作者 * @date 2020年12月05日17:22:43 * @param {Object} [title] - 参数说明 * @param {String} [columns] - 参数说明 * @example 调用示例 * <hbTable :title="title" :columns="columns" :tableData="tableData"></hbTable> */ --> ~~~