如何让别人喜欢你的代码

良好的编码习惯是编程人员的基本素养,有利于后期人员的维护和查看。

毕竟大家都喜欢美女和靓仔

目录

js函数注释规范

案例

其他

推荐链接


js函数注释规范

|---------|-----|--------------------|
| 常用符号 | 说明 | 用法 |
| @param | 参数 | @param {type} name |
| @return | 返回值 | @return {type} |

案例

javascript 复制代码
/**
 * 测试
 * @param {number} num
 * @return {void}
 */
function test(num) {
  console.log(num);
}

其他

javascript 复制代码
@api: 提供给第三方使用的接口
@author: 标明作者
@param: 参数
@return: 返回值
@todo: 待办
@version: 版本号
@inheritdoc: 文档继承
@property: 类属性
@property-read: 只读属性
@property-write: 只写属性
@const: 常量
@deprecated: 过期方法
@example: 示例
@final: 标识类是终态, 禁止派生
@global: 指明引用的全局变量
@static: 标识类、方法、属性是静态的
@ignore: 忽略
@internal: 限内部使用
@license: 协议
@link: 链接,引用文档等
@see: 与 link 类似, 可以访问内部方法或类
@method: 方法
@package: 命名空间
@since: 从指定版本开始的变动
@throws: 抛出异常
@uses: 使用
@var: 变量
@copyright: 版权声明

推荐链接

1.京东凹凸实验室前端代码规范,网址:[https://guide.aotu.io/](http://link.zhihu.com/?target=https%3A//guide.aotu.io/ "https://guide.aotu.io/")(https://guide.aotu.io/)

2.腾讯前端代码规范,网址:[http://tgideas.qq.com/doc/index.html](http://link.zhihu.com/?target=http%3A//tgideas.qq.com/doc/index.html "http://tgideas.qq.com/doc/index.html")(http://tgideas.qq.com/doc/index.html)

3.百度前端代码规范文档,网址:[https://github.com/ecomfe/spec](http://link.zhihu.com/?target=https%3A//github.com/ecomfe/spec "https://github.com/ecomfe/spec")(https://github.com/ecomfe/spec)

4.JavaScript Standard Style,网址:[https://github.com/standard/standard](http://link.zhihu.com/?target=https%3A//github.com/standard/standard "https://github.com/standard/standard")(https://github.com/standard/standard)

5.Vue官方特有的代码风格指南, 网址:[https://cn.vuejs.org/v2/style-guide/index.html](http://link.zhihu.com/?target=https%3A//cn.vuejs.org/v2/style-guide/index.html "https://cn.vuejs.org/v2/style-guide/index.html")(https://cn.vuejs.org/v2/style-guide/index.html)

6.阮一峰的ES6编程风格,网址:[http://es6.ruanyifeng.com/#docs/style](http://link.zhihu.com/?target=http%3A//es6.ruanyifeng.com/%23docs/style "http://es6.ruanyifeng.com/#docs/style")(http://es6.ruanyifeng.com/#docs/style)

7.《代码整洁整洁之道》,网址:[https://item.jd.com/12812626.html](http://link.zhihu.com/?target=https%3A//item.jd.com/12812626.html "https://item.jd.com/12812626.html")(https://item.jd.com/12812626.html)

8.ESLint ,网址:[https://eslint.bootcss.com/](http://link.zhihu.com/?target=https%3A//eslint.bootcss.com/ "https://eslint.bootcss.com/")(https://eslint.bootcss.com/)

9.Prettier,网址:[https://prettier.io/](http://link.zhihu.com/?target=https%3A//prettier.io/ "https://prettier.io/")(https://prettier.io/)

相关推荐
cc.ChenLy13 小时前
无法修改 el-dialog 样式原因及解决办法
javascript·vue.js·elementui
狮子座的男孩14 小时前
html+css基础:31、响应式布局(媒体类型,媒体特性,运算符,常用阈值)
前端·css·经验分享·html·响应式布局·媒体类型/特性·常用阈值
鲸鹏芯海微电子科技 (上海) 有限公司14 小时前
手机直连卫星,射频前端到底要解决什么?
前端·智能手机·低轨卫星·謓泽·鲸鹏芯海·毫米波射频·相控阵芯片
Flynt14 小时前
npm run dev --host 有风险?我把 Vite 这个 9.1 分漏洞复现了一遍
前端·vite
AI开源软件14 小时前
Vue3+SpringBoot3 业务配置统一管理:接管、保存与回退怎样保留有效值
java·前端·vue.js·spring boot·vue·ruoyi office
1-1=014 小时前
Vue 脚手架
前端·javascript·vue.js
Dumbness14 小时前
搜 platform 却给出 Form 表单:离线文档检索把短关键词当成了子串
javascript·node.js
honker_X15 小时前
Python字符串全攻略:从入门到精通
开发语言·python
半杯咖啡半行码15 小时前
Qt 隐式共享(Implicit Sharing)深度解析:机制、陷阱与 Qt6迁移
开发语言·数据库·qt
snow@li15 小时前
node:读取本地文件/静态文件服务器/打开Axure原型/prototype-server
前端·node