今儿个,咱来聊聊我在 VSCode 里头捣鼓的一个小玩意儿——koro1FileHeader,说白就是一个能自动给咱的代码文件加个头注释的小插件。别看它小,用起来是真的香!
安装过程
我也就是听朋友提一嘴,说这玩意儿能自动生成注释,省事儿。最烦的就是每次新建一个文件,还得手动敲那些个啥作者、创建时间、修改时间之类的注释,麻烦得很!于是我就琢磨着,装个试试呗。
安装过程挺简单的,打开 VSCode,点开左边那个“扩展”图标,在搜索框里输入“koro1FileHeader”,搜出来之后,点一下“安装”按钮,等个几秒钟,就完事儿。
配置过程
装好之后,还不能直接用,得稍微配置一下。按下快捷键“Ctrl+Shift+P”(Mac 上是“Cmd+Shift+P”),打开命令面板,输入“Preferences: Open Settings (JSON)”,打开 VSCode 的设置文件。
在设置文件里,我主要改两个地方:
小编温馨提醒:本站只提供游戏介绍,下载游戏推荐89游戏,89游戏提供真人恋爱/绅士游戏/3A单机游戏大全,点我立即前往》》》绅士游戏下载专区
- 这里头可以自定义文件头部的注释内容,我一般会写上作者、创建时间、修改时间、文件描述这些信息。
- 这个是用来设置函数注释的,我一般会写上函数的功能描述、参数说明、返回值说明等等。
具体的配置,每个人可以根据自己的习惯来调整,反正我是觉得,注释这东西,写清楚点总没错,以后自己回过头来看代码,也能少骂几句娘。
爽翻天的体验
配置好之后,就可以开始享受!新建一个文件,插件会自动在文件顶部加上我预先设置好的注释信息。更爽的是,每次保存文件的时候,它还会自动更新“修改时间”这一栏,简直不要太贴心!
写函数的时候,输入/然后回车,也会自动生成函数注释的模板,我只需要填上具体的内容就行,参数啥的它也会自动帮我提取出来,省我不少事儿。
总结
这个 koro1FileHeader 插件,我是强烈推荐大家去试试的。它能帮咱省去很多重复性的工作,让咱能更专注于写代码本身。用它之后,我感觉自己的代码都变得更“干净”,心情也舒畅不少,哈哈!
对,这玩意儿支持各种主流的编程语言,啥 JavaScript、Python、Java、C++ 之类的,统统不在话下,不管你是搞啥开发的,都可以放心大胆地用起来!