首页
学习
活动
专区
工具
TVP
发布
精选内容/技术社群/优惠产品,尽在小程序
立即前往

js】如何正确代码注释

/* 时间戳日期格式化函数 */ function formTime(time,isyear){ } 简单变量声明之类内容可以进行简单注释,但是函数就不能这样做了,要知道注释作用是一种为了让代码更易读...、易维护、易理解,起到提示作用,上面的两个注释都是正确,但是它起到作用太低了,在正式工作中我们往往会协同开发,这种注释是万万不可。...正确注释 正确注释 就是文档注释,先来看看是什么样子。...普通注释 文档注释 这种提示就像嵌代码在里面一样,而不是浮于表面了,在我们书写npm包时候,用户使用我们包,就能看到这种提示,对使用者特别友好。...npm install jsdoc -g 基本使用 jsdoc 文件名 其他使用方式可以去官网查看 jsdoc 33.js 执行完此命令,会生成一个out文件夹,查看里面的index页面即可,右边侧边栏会显示函数使用

16720
您找到你想要的搜索结果了吗?
是的
没有找到

JS规范注释

命令名描述 @param @argument 指定参数名和说明来描述一个函数参数 @returns 描述函数返回值 @author 指示代码作者 @deprecated 指示一个函数已经废弃,...而且在将来代码版本中将彻底删除。...要避免使用这段代码 @see 创建一个HTML链接,指向指定类描述 @version 指定发布版本 @requires 创建一个HTML链接,指向这个类所需指定类 @throws @exception...这与@see很类似,但{@link}能嵌在注释文本中 @fileoverview 这是一个特殊标记。...如果在文件第一个文档块中使用这个标记,则指定该文档块余下部分将用来提供这个文件概述 @class 提供类有关信息,用在构造函数文档中 @constructor 明确一个函数是某个类构造函数

3.3K20

代码注释艺术,优秀代码真的不需要注释吗?

似乎和我们很类似,我们程序员届也有这 2 件相辅相成事:最讨厌别人不写注释,更讨厌让自己写注释一段糟糕代码,往往大家最低预期是把注释写清楚,最合理做法通常应该对代码做优化。...注释会随着源代码,在进入预处理器或编译器处理后会被移除。这是雷布斯 1994 年写一段 MASM 汇编代码注释代码整体结构都非常清晰。...但如何使用注释,其实一直是一个备受争论的话题。当我们接手一段‘祖传代码’时,没有注释感觉简直让人抓狂,我们总是希望别人能提供更多注释。但软件届也有一段神话传说,叫做『我代码像诗一样优雅』。...无用注释或许是零注释另一个极端,我们担心自己写代码被人所吐槽,于是尽可能去补全注释,当你为 getLastDayOfMonth() 补一段 get last day of month 注释时,恭喜你...当需要为一段代码加上注释时,说明代码已经不能很好表达意图,于是大家开始为这段代码添加注释

53420

【Python】Python 注释 ( 单行注释 | 多行注释 | 代码示例 )

文章目录 一、Python 注释 1、单行注释 2、多行注释 3、代码示例 单行注释 : # 单行注释 多行注释 : """ 多行注释 多行注释 多行注释 """ 一、Python 注释 ---- Python...注释 可以 对 代码 进行解释说明 , 代码 注释 不会被执行 , 可以 增加代码可读性 ; 1、单行注释 单行注释 : Python 中 单行注释 以 # 开头 , # 右边是注释内容 ;...单行注释 中 , # 与 注释内容 建议使用 空格隔开 , 这是 Python 官方建议 , 建议大家都遵守该规范 ; 单行注释 可以 独立占一行 , 也可以 写在代码右侧 ; 在 C / C++ /...之间添加空格 , 警告信息消失 ; 代码示例 : 下面的代码中 , 第一行中 单行注释 独占一行 , 第二行中 单行注释代码右侧 ; # 单行注释 print(123) #...多行注释 多行注释 """ print(12.13) 3、代码示例 代码注释示例 : """ 在本代码中展示字面量 - 字面量写法 - 打印字面量 """ # 整型字面量 123 # 浮点型字面量

4.6K40

代码注释

只要写代码,就会遇到代码注释问题。在不同公司,不同项目组,不同项目中,可能会有不同注释标准。有些标准让我们感觉很受益,有些则让我们感觉很反感。...当时我们讨论代码注释该怎么写问题,最终同事抛出这么一个观点:“我之前在X为干过,那儿就需要每行代码都写注释,所以我们应该执行这样标准”。...因为我怀疑他之前可能在一家给X为干活外包公司工作。也许X为的确有严格代码注释量要求(也许“注释行数”/“代码行数”>0.5),于是这家外包公司就做了一个“任何一行代码都要写注释要求。...不要注释代码         我想这个问题是最最常见。大家翻翻自己项目的代码,可能都会遇到这种现象。当我们不需要一段代码时,可能也会估计是“永远不用了”还是“暂时不用了”。...假如我每隔一段注释一个笑脸,那么这幅画可能就没那么高艺术价值了。 ? 不要批判前人         写出完美的代码的确是非常稀少。所以我们阅读别人代码时,往往可以发现很多问题。

92030

Python 代码注释

注释作用 用自己熟悉语言,在程序中对某些代码进行标注说明,增强程序可读性。...单行注释 以 # 开头,# 右边所有东西都被当做说明文字,而不是真正要执行程序,只起到辅助说明作用 示例代码如下: #!...,然后再编写相应说明文字 在代码后面增加单行注释 在程序开发时,同样可以使用 # 在代码后面(旁边)增加说明性文字 但是,需要注意是,为了保证代码可读性,注释代码之间 至少要有 两个空格 示例代码如下...注释不是越多越好,对于一目了然代码,不需要添加注释 对于 复杂操作,应该在操作开始前写上若干行注释 对于 不是一目了然代码,应在其行尾添加注释(为了提高可读性,注释应该至少离开代码 2 个空格)...绝不要描述代码,假设阅读代码的人比你更懂 Python,他只是不知道你代码要做什么 养成写注释习惯,让自己、让同事、让借鉴者有着更好代码阅读体验。

1.2K20

一段取ADC代码

实现一个通过ADC采样电压值,每次采样5次,去掉一个最大值,一个最小值后,取剩下三次平均值。...if (batt_lvl_idx >= BATT_LVL_COUNT) { batt_lvl_idx = 0; } return; } //产生bug函数...(){ int times = BATT_LVL_COUNT; int max = 0; int min = 0; do{ //通过adc采样读取电压值,读过程中...参考下文言一下生成代码: 实现一个C方法,从一个5个整形数组中,去掉最大值,去掉一个最小值,然后求取平均值方法 你可以使用下面的C语言代码来实现这个功能。...这个代码定义了一个函数calculateAverage(),它接受一个包含5个整数数组作为参数,然后去掉数组中最大值和最小值,计算并返回剩余3个元素平均值。

10310

10段奇葩代码注释

码个蛋(codeegg)第 609 次推文 程序员作为一种“异类”,虽然他们平时给人们留下印象并不太好,觉得他们只会写代码。...但是有的时候不得不佩服他们天马行空想象力,他们可能会利用注释让你噗嗤一笑,下面我们来看看那些奇葩搞笑代码注释吧。 1 能用代码注释画出这么形象佛祖,看来真的是下了一番功夫。...最后留下那首诗,简直就是程序员生活真实写照。 ? 2 能用代码注释这么多羊,写着写着就真的该睡着了 (~﹃~)~zZ ?...6 这个注释写出键盘,我服,忍不住都想去按下键盘。 ? 7 你以为有神兽保护,就不会写出bug了吗? ? 8 这个注释小猪真的是很生动啊 ?...9 最后一段竟然是拉丁文,查了才知道意思是“你们进来的人,丢开一切希望吧”,完美契合图案。 ? 10 这个嘛,你们懂 ? ?

48320

如何评价一段代码

你这里规模说代码规模,也就是解决同样问题程序包含代码行数。如果单从这个因素讲,那一定是代码规模越小越好。但规模越小往往就会让代码本身复杂程度变高,影响可读性。...[] p; 没有嵌入式经验的人一定会问,这段代码申请了一段空间后什么也没做就释放掉了,这不是画蛇添足吗。...其实,这是一段容错代码,就是为了保证系统中有足够空间供后面的代码执行。 是不是想想就很可怜,程序运行中突然发现内存不够了,不得不停掉。 4 可读性 ?...对于越来越提倡代码规范中国软件行业来说,可读性开始成为不可忽视重要因素。无论是统一代码风格,还是规范命名、函数设计和注释,这些都必须注意。 在某些公司,代码规范被认为是评价代码第一要素。...铁打的项目流水程序员,一段可读性差代码对项目而言很可能意味着灭顶之灾。 对于初学者,代码规范这个要素必须非常重视,如果错过了这个培养良好习惯黄金时期,后面再改就很难了。

69490
领券