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

js】如何正确的写代码注释

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

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

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

    文章目录 一、Python 注释 1、单行注释 2、多行注释 3、代码示例 单行注释 : # 单行注释 多行注释 : """ 多行注释 多行注释 多行注释 """ 一、Python 注释 ---- Python...注释 可以 对 代码 进行解释说明 , 代码中的 注释 不会被执行 , 可以 增加代码的可读性 ; 1、单行注释 单行注释 : Python 中的 单行注释 以 # 开头 , # 右边是注释内容 ;...之间添加空格 , 警告信息消失 ; 代码示例 : 下面的代码中 , 第一行中的 单行注释 独占一行 , 第二行中的 单行注释代码的右侧 ; # 单行注释 print(123) #...单行注释 2、多行注释 Python 多行注释 使用三个双引号 引起来 ; 三个双引号 即可以进行单行注释 , 又可以多行注释 , 代码如下 : """ 多行注释 """ """ 多行注释...多行注释 多行注释 """ print(12.13) 3、代码示例 代码注释示例 : """ 在本代码中展示字面量 - 字面量写法 - 打印字面量 """ # 整型字面量 123 # 浮点型字面量

    4.8K40

    代码注释对齐

    图1 图2 感觉上我们认为图2是我们想要的注释对齐的效果。但感觉是不能拿来代码实现的。 所以我们需要定义什么叫注释对齐。如下图 假设代码部分的长度为CL,代码到//之间的长度为Width。...代码先上电梯,电梯容量为fact,等代码快上完,注释再上。代码上的时候发现没上满,就拿空格占位,空着也不让注释上。 2.指定Width(程序中的min)方式 相当于限额。...代码要先占前W个位置,人不够用空格占,都占完了,注释才能上来。 这样就会有个问题,代码如果超过W,位置不够用了怎么处理。 处理方式有, 2.1代码注释都将就,都满了,就顺序上了。...因为js不熟,所以代码基本是类C的风格,不太简洁。...()" id="beautify"> 格式化 代码还是精简一下,js的正则表达式很强大啊

    5610

    代码注释

    只要写代码,就会遇到代码注释的问题。在不同的公司,不同的项目组,不同的项目中,可能会有不同的注释标准。有些标准让我们感觉很受益,有些则让我们感觉很反感。...当时我们讨论代码注释该怎么写的问题,最终同事抛出这么一个观点:“我之前在X为干过,那儿就需要每行代码都写注释,所以我们应该执行这样的标准”。...也许X为的确有严格的代码注释量要求(也许“注释行数”/“代码行数”>0.5),于是这家外包公司就做了一个“任何一行代码都要写注释”的要求。...在讨论这个话题之前,我先说下我对代码注释的认识。         首先我认为代码要写的和注释一样表意。...往往一份文件包含代码注释两部分,而阅读这份文件也有两个主体——编译器和人。编译器只是通过代码来获得逻辑信息,而人的要通过代码注释一起理解逻辑和业务。

    93830

    Python 代码注释

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

    1.2K20
    领券