在前端开发中，我们经常需要在代码中加入注释，以便于理解、维护和合作开发。而现在，有一个方便易用的 npm 包——comment-on-it，它可以帮助我们在代码中快速添加注释，还支持 markdown 格式，非常方便。
安装
安装非常简单，直接在终端输入以下命令即可：
npm i comment-on-it -g
其中，-g 表示全局安装，可以在终端的任何地方使用。
基本用法
使用 comment-on-it 添加注释非常方便，只需要在代码中用一行注释标记开始，就可以使用该包的功能了。例如：
// @TODO: 完成登录页的样式
这里的注释标记是 @TODO:，我们可以在这个标记后面添加需要完成的内容，表示还有待办的任务。使用 comment-on-it 包提供的命令，则可以清晰地列出所有的待办任务。
命令如下：
comment-on-it --todo
这个命令会搜索当前目录以及子目录中的所有 .js 和 .md 文件，并列出其中所有的 @TODO: 注释，以及跟在其后的待办事项内容。
除此之外，comment-on-it 还支持以下注释标记：
@FIXME:，表示需要修复的问题。@NOTE:，表示需要记录的信息。@HACK:，表示需要临时的解决方法。@OPTIMIZE:，表示需要优化的地方。@DEBUG:，表示需要调试的地方。
使用场景非常广，可以结合实际工作灵活使用。
高级用法
除了以上功能外，comment-on-it 还支持更进一步的功能，甚至可以根据注释标记的内容，自动生成文档和代码片段。
自动生成文档
我们可以使用 @DOC: 注释标记来生成文档，只需要在注释标记后面添加文档内容即可，例如：
// @DOC: 这里介绍一下 add 方法的使用方法。
// @DOC: 调用方式为 add(x, y)，将返回 x + y 的结果。
function add(x, y) {
return x + y;
}接着，我们使用 comment-on-it 的 --doc 命令生成文档：
comment-on-it --doc
comment-on-it 会根据注释标记生成 markdown 格式的文档，例如：
# add 这里介绍一下 add 方法的使用方法。 调用方式为 add(x, y)，将返回 x + y 的结果。
我们可以将这段文档复制到 README.md、API 文档或者其他文档中，非常方便。
自动生成代码片段
当我们在代码中遇到需要浏览器环境的 API 或者 DOM 操作时，常常需要编写一些 demo 进行实验。这时候，我们可以使用 comment-on-it 的 --code 命令，根据注释标记生成代码片段，例如：
// @CODE:
// document.getElementById('btn').onclick = function() {
// console.log('btn clicked!');
// }使用 comment-on-it 的 --code 命令之后，会在控制台输出这段代码的 HTML 和 JS 片段，例如：
-- -------------------- ---- -------
--------- -----
------
------
----- ----------------
---------------
-------
------
------- ------------------
--------
-- -- ----
-------------------------------------- - ---------- -
---------------- -----------
-
---------
-------
-------我们只需要将这段代码复制到测试工程中，即可进行测试。
总结
comment-on-it 是一个非常方便的 npm 包，可以帮助我们在代码中添加注释、生成文档和代码片段等功能。在实际工作中，我们可以结合自己的需求，灵活运用这个工具，提高开发效率。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/600564e781e8991b448e18b6