vscode如何实现新建文件自动添加作者注释

1. 什么是作者注释

作者注释是指在代码文件中添加一些说明信息,让其他开发者了解该文件的基本信息,如文件名、作者名、更新时间等等,以便于开发者们更好的了解项目。在写代码时,添加作者注释是一个很好的习惯,它能够提高代码的可读性和可维护性。

2. VSCode如何添加作者注释

VSCode自带有一个插件——Document This,可以帮助我们快速添加注释信息,包括作者注释。以下是详细的操作步骤:

2.1 安装Document This插件

在VSCode的扩展市场搜索插件并进行安装。

Document This:

- Publisher: oilexxxi

- VS Marketplace Link: https://marketplace.visualstudio.com/items?itemName=joelday.docthis

2.2 新建文件

在VSCode中新建一个空文件:

File → New File

2.3 自动添加作者注释

在新建的空文件中输入“/”之后输入“**”,按下回车,会自动添加一段注释的模板,如下:

/**

* @file

* @author

* @date

* @description

*/

在模板中,我们需要填写相应的信息,使其能够真正地反映该文件的信息。

2.4 填写注释信息

2.4.1 文件名(@file)

在文件名后面填写相应的信息,即可将文件名添加到注释中:

/**

* @file app.js

* @author

* @date

* @description

*/

2.4.2 作者名(@author)

在作者名后面填写相应的信息,即可将作者名添加到注释中:

/**

* @file app.js

* @author Jack

* @date

* @description

*/

2.4.3 更新时间(@date)

在更新时间后面填写相应的信息,即可将更新时间添加到注释中:

/**

* @file app.js

* @autho Jack

* @date 2021-01-01

* @description

*/

2.4.4 文件描述(@description)

在文件描述后面填写相应的信息,即可将文件描述添加到注释中:

/**

* @file app.js

* @autho Jack

* @date 2021-01-01

* @description This is a demo file for showing how to add author comment in VSCode.

*/

3. 自动添加作者注释的优化

上述方法虽然可以快速添加作者注释,但需要手工填写每个注释字段的值,比较麻烦。我们可以使用一个第三方插件——Author Info,让VSCode自动添加作者注释。

3.1 安装Author Info插件

在VSCode的扩展市场搜索插件并进行安装:

Author Info:

- Publisher: KingMario

- VS Marketplace Link: https://marketplace.visualstudio.com/items?itemName=KingMario.vscode-author-info

3.2 在用户设置中配置作者信息

在VSCode的“用户设置”中配置作者信息:

{

"author-info.author": "Jack",

"author-info.dateFormat": "yyyy-MM-dd"

}

其中,author是我们的作者名,dateFormat是日期格式。

3.3 打开自动添加注释功能

按下“Ctrl + Shift + P”,打开命令面板,并输入,选择该命令即可开启auto-comment功能。如下:

Ctrl + Shift + P → Enable Author Info

3.4 创建新文件后自动添加注释

此时,我们创建一个新文件时,VSCode会自动添加作者注释了。

/** 

* @file app.js

* @authot Jack

* @date 2021-01-01

* @description This is a demo file for showing how to add author comment in VSCode.

*/

4. 总结

在编写代码时,添加作者注释是个好习惯,能够提高代码的可读性和可维护性。VSCode提供了多种添加注释的方法,我们可以根据自己的需求进行选择。

免责声明:本文来自互联网,本站所有信息(包括但不限于文字、视频、音频、数据及图表),不保证该信息的准确性、真实性、完整性、有效性、及时性、原创性等,版权归属于原作者,如无意侵犯媒体或个人知识产权,请来电或致函告之,本站将在第一时间处理。猿码集站发布此文目的在于促进信息交流,此文观点与本站立场无关,不承担任何责任。