# file-description-plugin-for-intellj

**Repository Path**: crayonlen/file-description-plugin-for-intellj

## Basic Information

- **Project Name**: file-description-plugin-for-intellj
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 2
- **Created**: 2025-06-24
- **Last Updated**: 2025-06-24

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# File Description Plugin for Intellij


<!-- Plugin description -->
This is a plugin that adds header comments to files and automatically updates the last editor and editing time

Currently supports java, kt, css, scss, less, ts, tsx, js, jsx, html, vue, dart, php, env, yml, python, go, C language files to automatically add and update file header comment information

The header annotation configuration of the VsCode plug-in koroFileHeader is supported

Support for randomly generating interesting comments


这是一个自动给文件添加头部注释的插件，并自动更新最后编辑时间和编辑时间

目前支持java, kt, css, scss, less, ts, tsx, js, jsx, html, vue, dart, php, env, yml, python, go, C语言文件自动添加和更新文件头部注释信息

支持VsCode插件koroFileHeader的头部注释配置
```JSON
{
    // Author字段是文件的创建者 可以在specialOptions中更改特殊属性
    // 公司项目和个人项目可以配置不同的用户名与邮箱 搜索: gitconfig includeIf  比如: https://ayase.moe/2021/03/09/customized-git-config/
    // 自动提取当前git config中的: 用户名、邮箱
    "Author": "git config user.name && git config user.email", // 同时获取用户名与邮箱
    // "Author": "git config user.name", // 仅获取用户名
    // "Author": "git config user.email", // 仅获取邮箱
    // "Author": "OBKoro1", // 写死的固定值 不从git config中获取
    "Date": "Do not edit", // 文件创建时间(不变)
    // LastEditors、LastEditTime、FilePath将会自动更新 如果觉得时间更新的太频繁可以使用throttleTime(默认为1分钟)配置更改更新时间。
    "LastEditors": "git config user.name && git config user.email", // 文件最后编辑者 与Author字段一致
    // 由于编辑文件就会变更最后编辑时间，多人协作中合并的时候会导致merge
    // 可以将时间颗粒度改为周、或者月，这样冲突就减少很多。搜索变更时间格式: dateFormat
    "LastEditTime": "Do not edit", // 文件最后编辑时间
    // 输出相对路径，类似: /文件夹名称/src/index.js
    "FilePath": "Do not edit", // 文件在项目中的相对路径 自动更新
    // 插件会自动将光标移动到Description选项中 方便输入 Description字段可以在specialOptions更改
    "Description": "", // 介绍文件的作用、文件的入参、出参。
    // custom_string_obkoro1~custom_string_obkoro100都可以输出自定义信息
    // 可以设置多条自定义信息 设置个性签名、留下QQ、微信联系方式、输入空行等
    "custom_string_obkoro1": "", 
    // 版权声明 保留文件所有权利 自动替换年份 获取git配置的用户名和邮箱
    // 版权声明获取git配置, 与Author字段一致: ${git_name} ${git_email} ${git_name_email}
    "custom_string_obkoro1_copyright": "Copyright (c) ${now_year} by ${git_name_email}, All Rights Reserved. "
    // "custom_string_obkoro1_copyright": "Copyright (c) ${now_year} by 写死的公司名/用户名, All Rights Reserved. "
}
```
支持随机生成趣味注释

更多功能慢慢开发中。。。
<!-- Plugin description end -->

各位老爷觉得好用且有闲钱儿话，可以打赏一下哟~~~

![paycode](paycode.jpg)