代码注释语法及规范参考

最新推荐文章于 2024-06-25 22:00:00 发布

29号同学

最新推荐文章于 2024-06-25 22:00:00 发布

阅读量1.4k

点赞数

分类专栏： Web前端文章标签： js 注释语法 jsDoc

本文链接：https://blog.csdn.net/ZYD45/article/details/106492461

版权

本文介绍了代码注释的规范，特别是JavaScript（JS）中的注释。推荐使用JSDoc标准，包括@param标签来注解参数。对于Markdown语法，它常用于创建描述和标题。在VS Code中，可以使用Document This插件快速生成注释。服务端方法注释如C#中的#region和summary，用于方法区域分隔和提供方法摘要信息。

摘要由CSDN通过智能技术生成

在实际开发中，我们在定义一些类或组件时，经常要写一些注释。前端注释如下：

/**
* @property {String} 日程拥有者的ID
* @desc 用于加载日程信息时指定 拥有者
* ### 示例:'T001'
*/
ownerID: null,
/**
* @property {Array}  日程拥有者的ID 数组
* @desc 用于加载日程信息时指定 拥有者
* # 示例:['T001']
*/
ownerArr: [],
/**
* @property {String}  日程显示及添加类型
* @desc 用于加载日程信息时指定类型 以及 新建时固定类型
* @value `plan` 计划 `act` 活动 
* ### 示例:'plan'
*/
type: null,

当鼠标悬浮在其上时，可以看到这些注释信息