{"id":13559964,"url":"https://github.com/OBKoro1/koro1FileHeader","last_synced_at":"2025-04-03T15:31:36.985Z","repository":{"id":37432123,"uuid":"132321714","full_name":"OBKoro1/koro1FileHeader","owner":"OBKoro1","description":"VSCode插件：自动生成，自动更新VSCode文件头部注释, 自动生成函数注释并支持提取函数参数，支持所有主流语言，文档齐全，使用简单，配置灵活方便，持续维护多年。","archived":false,"fork":false,"pushed_at":"2023-04-19T07:14:47.000Z","size":64562,"stargazers_count":5799,"open_issues_count":85,"forks_count":280,"subscribers_count":34,"default_branch":"master","last_synced_at":"2025-03-29T03:01:36.363Z","etag":null,"topics":["annotations","fileheader","functionn-annotation","header-annotation","vscode","vscode-plugin"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/OBKoro1.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":null,"patreon":null,"open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"lfx_crowdfunding":null,"custom":"https://github.com/OBKoro1/koro1FileHeader/blob/dev/images/pay.jpg?raw=true"}},"created_at":"2018-05-06T08:50:53.000Z","updated_at":"2025-03-29T02:08:42.000Z","dependencies_parsed_at":"2024-08-01T13:15:51.189Z","dependency_job_id":"a69813d9-7104-4d95-a9a9-8ef3ec997124","html_url":"https://github.com/OBKoro1/koro1FileHeader","commit_stats":null,"previous_names":[],"tags_count":30,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OBKoro1%2Fkoro1FileHeader","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OBKoro1%2Fkoro1FileHeader/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OBKoro1%2Fkoro1FileHeader/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OBKoro1%2Fkoro1FileHeader/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/OBKoro1","download_url":"https://codeload.github.com/OBKoro1/koro1FileHeader/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247027962,"owners_count":20871630,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["annotations","fileheader","functionn-annotation","header-annotation","vscode","vscode-plugin"],"created_at":"2024-08-01T13:00:35.551Z","updated_at":"2025-04-03T15:31:31.968Z","avatar_url":"https://github.com/OBKoro1.png","language":"JavaScript","readme":"# koroFileHeader \n\n\u003ca href=\"https://github.com/OBKoro1/koro1FileHeader\"\u003e\n    \u003cimg alt=\"koro1FileHeader Repo stars\" src=\"https://img.shields.io/github/stars/OBKoro1/koro1FileHeader\"\u003e\n\u003c/a\u003e\n\u003ca href=\"https://github.com/OBKoro1/koro1FileHeader/wiki/%E9%85%8D%E7%BD%AE%E5%AD%97%E6%AE%B5\"\u003e\n    \u003cimg alt=\"wiki文档详细\" src=\"https://img.shields.io/badge/wiki文档-齐全详细-blue\"\u003e\n\u003c/a\u003e\n\u003ca href=\"https://github.com/OBKoro1/koro1FileHeader/wiki/%E6%9B%B4%E6%96%B0%E6%97%A5%E5%BF%97\"\u003e\n    \u003cimg alt=\"持续维护\" src=\"https://img.shields.io/badge/2018年开源-持续维护-blue\"\u003e\n\u003c/a\u003e\n\u003ca href=\"https://github.com/OBKoro1/koro1FileHeader/releases\"\u003e\n    \u003cimg alt=\"cicd\" src=\"https://img.shields.io/badge/版本打包-release-blue\"\u003e\n\u003c/a\u003e\n\u003ca href=\"https://github.com/OBKoro1/koro1FileHeader/blob/master/LICENSE\"\u003e\n    \u003cimg alt=\"开源协议-MIT\" src=\"https://img.shields.io/badge/license-MIT-blue\"\u003e\n\u003c/a\u003e\n\n### 简介\n\n1. VSCode插件: 用于一键生成文件头部注释并自动更新最后编辑人和编辑时间、函数注释自动生成和参数提取。\n2. 插件可以帮助用户养成良好的编码习惯，规范整个团队风格。\n3. 从2018年5月维护至今, 关闭issue 500+ ，拥有39.7w+的用户，VSCode图表统计日均安装200-500\n4. 经过多版迭代后，插件支持所有主流语言,灵活方便，文档齐全，食用简单！\n5. 觉得插件不错的话，就给个[Star](https://github.com/OBKoro1/koro1FileHeader)⭐️吧~\n\n### 主要功能\n\n1. 自动生成文件头部注释，自动更新最后编辑人、最后编辑时间等。\n2. 一键生成函数注释，支持函数参数自动提取并列到注释中。\n3. 支持添加佛祖保佑永无bug、神兽护体、甩葱少女等好玩有趣的图像注释\n4. 配置非常灵活方便，各种细节都能配置，可以量身打造适合你的注释。\n4. 支持所有主流语言, 配置文档非常详细，齐全。\n\n### 使用效果：\n\n**头部注释和注释图案**\n\n![example.gif](https://raw.githubusercontent.com/OBKoro1/koro1FileHeader/master/images/example.gif)\n\n**函数注释: 自动提取函数参数**\n\n1. 支持主流语言自动提取函数参数\n\n![koroFileHeader函数参数提取](https://github.com/OBKoro1/koro1FileHeader/blob/master/images/function-params.gif?raw=true)\n\n2. 多行函数参数支持自动提取\n\n![多行函数参数自动提取参数](https://github.com/OBKoro1/koro1FileHeader/blob/dev/images/docs/multiLineParamsCreate.gif?raw=true)\n\n**注释图案**\n\n[支持一键添加佛祖保佑永无BUG、神兽护体等注释图案](https://github.com/OBKoro1/koro1FileHeader/wiki/%E4%BD%9B%E7%A5%96%E4%BF%9D%E4%BD%91%E6%B0%B8%E6%97%A0BUG%E3%80%81%E7%A5%9E%E5%85%BD%E6%8A%A4%E4%BD%93%E3%80%81%E6%B3%A8%E9%87%8A%E5%9B%BE%E6%A1%88)\n\n![添加注释图案](https://github.com/OBKoro1/koro1FileHeader/raw/master/images/codeDesign.gif?raw=true)\n\n### 安装和快速上手\n\n[安装和快速上手](https://github.com/OBKoro1/koro1FileHeader/wiki/%E5%AE%89%E8%A3%85%E5%92%8C%E5%BF%AB%E9%80%9F%E4%B8%8A%E6%89%8B)\n\n### 快速查看插件功能与配置方法\n\n**功能目录**：查看[配置](https://github.com/OBKoro1/koro1FileHeader/wiki/%E9%85%8D%E7%BD%AE)右侧自动生成的markdown目录，浏览所有最新最全的功能。\n\n**配置简介**：[配置字段](https://github.com/OBKoro1/koro1FileHeader/wiki/%E9%85%8D%E7%BD%AE%E5%AD%97%E6%AE%B5)\n\n## Wiki文档\n\n[安装和快速上手](https://github.com/OBKoro1/koro1FileHeader/wiki/%E5%AE%89%E8%A3%85%E5%92%8C%E5%BF%AB%E9%80%9F%E4%B8%8A%E6%89%8B)\n\n[支持语言](https://github.com/OBKoro1/koro1FileHeader/wiki/%E6%94%AF%E6%8C%81%E8%AF%AD%E8%A8%80)\n\n[插件设置/配置](https://github.com/OBKoro1/koro1FileHeader/wiki/%E9%85%8D%E7%BD%AE)\n\n[配置字段](https://github.com/OBKoro1/koro1FileHeader/wiki/%E9%85%8D%E7%BD%AE%E5%AD%97%E6%AE%B5)\n\n[更新日志](https://github.com/OBKoro1/koro1FileHeader/wiki/%E6%9B%B4%E6%96%B0%E6%97%A5%E5%BF%97)\n\n[常见问题](https://github.com/OBKoro1/koro1FileHeader/wiki/%E5%B8%B8%E8%A7%81%E9%97%AE%E9%A2%98)\n\n[佛祖保佑永无BUG、神兽护体等注释图案](https://github.com/OBKoro1/koro1FileHeader/wiki/%E4%BD%9B%E7%A5%96%E4%BF%9D%E4%BD%91%E6%B0%B8%E6%97%A0BUG%E3%80%81%E7%A5%9E%E5%85%BD%E6%8A%A4%E4%BD%93%E3%80%81%E6%B3%A8%E9%87%8A%E5%9B%BE%E6%A1%88)\n\n\n### 我的其他开源推荐\n#### [stop-mess-around](https://github.com/OBKoro1/stop-mess-around)\n\n减少摸鱼的时间和频率的Chrome插件：**在上班/学习期间很容易下意识的打开摸鱼网站，插件帮助我们减少摸鱼的时间和频率，提高我们上班和学习的效率，节省时间用于学习提升自己或者享受生活**。\n\n![](https://github.com/OBKoro1/stop-mess-around/blob/dev/static/example/run-introduction8M.gif?raw=true)\n\n#### [AutoCommit](https://github.com/OBKoro1/autoCommit)\n\n这是一个用于Git自动commit的VSCode插件，它可以用来补充之前忘记提交commit，帮助你把首页的绿色格子填满。\n\n![](https://github.com/OBKoro1/autoCommit/raw/master/images/autoCommit.gif?raw=true)\n\n### [web-basics](https://github.com/OBKoro1/web-basics)\n\n收集和整理了一个大厂前端需要掌握能力的仓库。\n\n其中分为JS基础能力，大厂场景题、大厂面试真题。\n\n希望能够帮助大家提升自己的能力，在面试的时候能够游刃有余，轻松拿到高薪offer。\n\n![大厂前端需要掌握的能力](https://github.com/OBKoro1/web-basics/blob/main/static/web-basic-example.gif?raw=true)\n\n### 用爱发电，求赞助 😭\n\n开源不易，本插件的开发与维护全都是利用业余时间。\n\n如果觉得这个效率工具还不错, 对你有所帮助，就赞助支持一下我的工作吧。\n\n请我喝杯水吧，十块八块不嫌多，三块五块不嫌少 ❤️\n\n\u003cimg src=\"https://raw.githubusercontent.com/OBKoro1/koro1FileHeader/dev/images/pay.jpg\" alt=\"赞助\" width=\"500px\" style=\"display: block;\"/\u003e\n\n\n### License\n\n[MIT](http://opensource.org/licenses/MIT)\n\n### 求Star\n\n如果觉得还不错的话，就给个 [Star](https://github.com/OBKoro1/koro1FileHeader) ⭐️ 鼓励一下我吧~\n\n## 联系我\n\n[掘金](https://juejin.im/user/78820536236951)、[前端进阶积累](http://obkoro1.com/web_accumulate/)、[公众号](https://user-gold-cdn.xitu.io/2018/5/1/1631b6f52f7e7015?w=344\u0026h=344\u0026f=jpeg\u0026s=8317)、[GitHub](https://github.com/OBKoro1)、[微信](https://raw.githubusercontent.com/OBKoro1/articleImg_src/master/weibo_img_move/005Y4rCogy1fsnslyz5pnj309j0cdgm6.jpg):OBkoro1、邮箱：obkoro1@foxmail.com\n\n","funding_links":["https://github.com/OBKoro1/koro1FileHeader/blob/dev/images/pay.jpg?raw=true"],"categories":["JavaScript","编辑器"],"sub_categories":["资源传输下载"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FOBKoro1%2Fkoro1FileHeader","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FOBKoro1%2Fkoro1FileHeader","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FOBKoro1%2Fkoro1FileHeader/lists"}