首页
学习
活动
专区
工具
TVP
发布
精选内容/技术社群/优惠产品,尽在小程序
立即前往
您找到你想要的搜索结果了吗?
是的
没有找到

JS规范注释

命令名描述 @param @argument 指定参数名和说明来描述一个函数参数 @returns 描述函数返回值 @author 指示代码作者 @deprecated 指示一个函数已经废弃,...这与@see很类似,但{@link}能嵌在注释文本 @fileoverview 这是一个特殊标记。...如果在文件第一个文档块中使用这个标记,则指定该文档块余下部分将用来提供这个文件概述 @class 提供类有关信息,用在构造函数文档 @constructor 明确一个函数是某个类构造函数...私有类和函数不会出现在HTML文档,除非运行JSDoc时提供了–private命令行选项 @final 指示一个值是常量值。.../** * @description 加法运算 * @param {Num} num1 加数 * @param {Num} num2 被加数 * @return {Num} result 结果

3.3K20

Java注释

单行注释 写法: //此行后面均是注释内容 例如://我是一行注释|´・ω・)ノ 多行注释 写法: /* 我是注释内容1 我是注释内容2 */ 单/多行注释作用: 增强代码可读性 文档注释...写法: /** *我是文档注释内容 */ 文档注释作用: 注释允许你在程序嵌入关于程序信息。...你可以使用 javadoc 工具软件来生成信息,并输出到HTML文件。 说明注释,使你更加方便记录你程序信息。...javadoc标签 在开始 /** 之后,第一行或几行是关于类、变量和方法主要描述。 之后,你可以包含一个或多个各种各样 @ 标签。...每一个 @ 标签必须在一个新行开始或者在一行开始紧跟星号(*). 多个相同类型标签应该放成一组。例如,如果你有三个 @see 标签,可以将它们一个接一个放在一起。 示例:

1.4K20

js】如何正确写代码注释

错误注释注释是不是这样? //时间戳日期格式化函数 function formTime(time,isyear){ } 亦或者是这样?...、易维护、易理解,起到提示作用,上面的两个注释都是正确,但是它起到作用太低了,在正式工作我们往往会协同开发,这种注释是万万不可。...正确注释 正确注释 就是文档注释,先来看看是什么样子。.../** * @author 小解同志 https://lamian.blog.csdn.net * @param {String} time 接受用户传来时间戳 * @param...npm install jsdoc -g 基本使用 jsdoc 文件名 其他使用方式可以去官网查看 jsdoc 33.js 执行完此命令,会生成一个out文件夹,查看里面的index页面即可,右边侧边栏会显示函数使用

15220

shell批量注释和取消注释方法

,除了正常做法,每行前面加#进行注释外 一、手动添加注释 我们还可以用个取巧办法,也可以写成下面这种 #!...还可以将1-4输入重定向追加到黑洞 #!...1.块选择模式 插入注释 首先用vim打开我们要操作脚本, 然后将光标移动到我们要操作首行(这里我们移动到echo "1"左方),接着按v进入-- 可视(visual) --模式 ?...取消注释 ctrl + v 进入块选择模式,选中你要删除行首注释符号,注意// 要选中两个, ?...选好之后按d即可删除注释 方法二 替换命令 批量注释: 使用下面命令在指定行首添加注释: :起始行号,结束行号s/^/注释符/g 我们这里是要操作第2行到第5行,所以用vim打开脚本后,输入

4.5K40
领券