如何让别人喜欢你的代码

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

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

目录

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/](https://guide.aotu.io/)

2.腾讯前端代码规范,网址:[http://tgideas.qq.com/doc/index.html](http://tgideas.qq.com/doc/index.html)

3.百度前端代码规范文档,网址:[https://github.com/ecomfe/spec](https://github.com/ecomfe/spec)

4.JavaScript Standard Style,网址:[https://github.com/standard/standard](https://github.com/standard/standard)

5.Vue官方特有的代码风格指南, 网址:[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://es6.ruanyifeng.com/#docs/style)

7.《代码整洁整洁之道》,网址:[https://item.jd.com/12812626.html](https://item.jd.com/12812626.html)

8.ESLint ,网址:[https://eslint.bootcss.com/](https://eslint.bootcss.com/)

9.Prettier,网址:[https://prettier.io/](https://prettier.io/)

相关推荐
℃CCCC2 分钟前
请求库-axios
开发语言·华为·网络请求·harmonyos·deveco studio·axios请求·arkts编程
ling__i8 分钟前
java day18
java·开发语言
矛取矛求8 分钟前
日期类的实现
开发语言·c++·算法
非ban必选9 分钟前
netty-scoket.io路径配置
java·服务器·前端
大翻哥哥19 分钟前
Python 2025:AI工程化与智能代理开发实战
开发语言·人工智能·python
在下雨59938 分钟前
项目讲解1
开发语言·数据结构·c++·算法·单例模式
再努力"亿"点点41 分钟前
Sklearn(机器学习)实战:鸢尾花数据集处理技巧
开发语言·python
じòぴé南冸じょうげん43 分钟前
小程序的project.private.config.json是无依赖文件,那可以删除吗?
前端·小程序·json
会豪1 小时前
Electron主进程渲染进程如何优雅的进行通信
前端
jianghaha20111 小时前
前端 Word 模板参入特定数据 并且下载
前端·word