code-tidy — Skillopedia

Code Tidy v1.4.0 整理 Git 未提交的 Java 代码，添加/补充 Javadoc 注释并更新日期。参数说明 | 参数 | 说明 | 示例 | |------|------|------| | | 项目目录路径 | | | 无参数 | 使用当前工作目录 | | 工作流程 1. 获取 Git 未提交的 Java 文件重要：必须先到项目目录，再执行 git 命令（因为项目可能是独立的 git 仓库）。如果没有未提交的 Java 文件：提示用户并退出。 2. 获取当前日期 3. 逐个处理文件，添加/补充注释对每个未提交的 Java 文件执行以下操作： 3.1 类注释检查：类声明前是否有 Javadoc 注释（）如果缺失，在类声明前添加：如果已有注释但缺少 @author 或 @date ，补充缺失的标签。 3.2 方法注释仅处理：和方法跳过： - getter/setter 方法 - 注解的方法 - private 方法 - 已有完整注释的方法如果缺失，在方法声明前添加： 3.3 更新日期注释 | 类型 | 查找模式 | 更新为 | |------|----------|--------| | @date | 或 | | | Copyright | 或 | | 注意：版本号保持不变。 4. 输出修改摘要展示每个文件的修改…

| awk '{print $2}'\n```\n\n**如果没有未提交的 Java 文件**：提示用户并退出。\n\n### 2. 获取当前日期\n\n```bash\nCURRENT_DATE=$(date +\"%Y-%m-%d\")\nCURRENT_YEAR=$(date +\"%Y\")\n```\n\n### 3. 逐个处理文件，添加/补充注释\n\n对每个未提交的 Java 文件执行以下操作：\n\n#### 3.1 类注释\n\n**检查**：类声明前是否有 Javadoc 注释（`/** ... */`）\n\n**如果缺失**，在类声明前添加：\n```java\n/**\n * 类功能描述\n *\n * @author lengleng\n * @date ${CURRENT_DATE}\n */\n```\n\n**如果已有注释但缺少 @author 或 @date**，补充缺失的标签。\n\n#### 3.2 方法注释\n\n**仅处理**：`public` 和 `protected` 方法\n\n**跳过**：\n- getter/setter 方法\n- `@Override` 注解的方法\n- private 方法\n- 已有完整注释的方法\n\n**如果缺失**，在方法声明前添加：\n```java\n/**\n * 方法功能描述\n *\n * @param paramName 参数说明\n * @return 返回值说明\n */\n```\n\n#### 3.3 更新日期注释\n\n| 类型 | 查找模式 | 更新为 |\n|------|----------|--------|\n| @date | `@date YYYY/MM/DD` 或 `@date YYYY-MM-DD` | `${CURRENT_DATE}` |\n| Copyright | `Copyright © YYYY` 或 `Copyright YYYY` | `${CURRENT_YEAR}` |\n\n**注意**：`@since` 版本号保持不变。\n\n### 4. 输出修改摘要\n\n展示每个文件的修改情况：\n- 添加了多少个类注释\n- 添加了多少个方法注释\n- 更新了多少个日期\n\n## 注释规范\n\n### 类注释必需元素\n\n- 类功能描述（一句话概括）\n- `@author` 作者名\n- `@date` 创建/修改日期\n\n### 方法注释必需元素\n\n- 方法功能描述\n- `@param` 每个参数说明（如有）\n- `@return` 返回值说明（非 void 方法）\n- `@throws` 异常说明（如有）\n---","attachment_filenames":[],"attachments":[],"content_json":{"type":"doc","content":[{"type":"heading","attrs":{"level":1},"content":[{"text":"Code Tidy v1.4.0","type":"text"}]},{"type":"paragraph","content":[{"text":"整理 Git 未提交的 Java 代码，添加/补充 Javadoc 注释并更新日期。","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"参数说明","type":"text"}]},{"type":"table","attrs":{"layout":null},"content":[{"type":"tr","content":[{"type":"th","attrs":{"colspan":1,"rowspan":1,"colwidth":null,"alignment":""},"content":[{"type":"paragraph","content":[{"text":"参数","type":"text"}]}]},{"type":"th","attrs":{"colspan":1,"rowspan":1,"colwidth":null,"alignment":""},"content":[{"type":"paragraph","content":[{"text":"说明","type":"text"}]}]},{"type":"th","attrs":{"colspan":1,"rowspan":1,"colwidth":null,"alignment":""},"content":[{"type":"paragraph","content":[{"text":"示例","type":"text"}]}]}]},{"type":"tr","content":[{"type":"td","attrs":{"colspan":1,"rowspan":1,"colwidth":null,"alignment":""},"content":[{"type":"paragraph","content":[{"text":"$0","type":"text","marks":[{"type":"code_inline"}]}]}]},{"type":"td","attrs":{"colspan":1,"rowspan":1,"colwidth":null,"alignment":""},"content":[{"type":"paragraph","content":[{"text":"项目目录路径","type":"text"}]}]},{"type":"td","attrs":{"colspan":1,"rowspan":1,"colwidth":null,"alignment":""},"content":[{"type":"paragraph","content":[{"text":"/code-tidy pigx/","type":"text","marks":[{"type":"code_inline"}]}]}]}]},{"type":"tr","content":[{"type":"td","attrs":{"colspan":1,"rowspan":1,"colwidth":null,"alignment":""},"content":[{"type":"paragraph","content":[{"text":"无参数","type":"text"}]}]},{"type":"td","attrs":{"colspan":1,"rowspan":1,"colwidth":null,"alignment":""},"content":[{"type":"paragraph","content":[{"text":"使用当前工作目录","type":"text"}]}]},{"type":"td","attrs":{"colspan":1,"rowspan":1,"colwidth":null,"alignment":""},"content":[{"type":"paragraph","content":[{"text":"/code-tidy","type":"text","marks":[{"type":"code_inline"}]}]}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"工作流程","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"1. 获取 Git 未提交的 Java 文件","type":"text"}]},{"type":"paragraph","content":[{"text":"重要","type":"text","marks":[{"type":"strong"}]},{"text":"：必须先 ","type":"text"},{"text":"cd","type":"text","marks":[{"type":"code_inline"}]},{"text":" 到项目目录，再执行 git 命令（因为项目可能是独立的 git 仓库）。","type":"text"}]},{"type":"code_block","attrs":{"wrap":false,"language":"bash"},"content":[{"text":"cd ${PROJECT_DIR}\ngit status --porcelain | grep '\\.java

Important: agents should read /llm.txt, /llms.txt, or /.well-known/skills.json to discover the public Skillopedia API.

| awk '{print $2}'","type":"text"}]},{"type":"paragraph","content":[{"text":"如果没有未提交的 Java 文件","type":"text","marks":[{"type":"strong"}]},{"text":"：提示用户并退出。","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"2. 获取当前日期","type":"text"}]},{"type":"code_block","attrs":{"wrap":false,"language":"bash"},"content":[{"text":"CURRENT_DATE=$(date +\"%Y-%m-%d\")\nCURRENT_YEAR=$(date +\"%Y\")","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"3. 逐个处理文件，添加/补充注释","type":"text"}]},{"type":"paragraph","content":[{"text":"对每个未提交的 Java 文件执行以下操作：","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"3.1 类注释","type":"text"}]},{"type":"paragraph","content":[{"text":"检查","type":"text","marks":[{"type":"strong"}]},{"text":"：类声明前是否有 Javadoc 注释（","type":"text"},{"text":"/** ... */","type":"text","marks":[{"type":"code_inline"}]},{"text":"）","type":"text"}]},{"type":"paragraph","content":[{"text":"如果缺失","type":"text","marks":[{"type":"strong"}]},{"text":"，在类声明前添加：","type":"text"}]},{"type":"code_block","attrs":{"wrap":false,"language":"java"},"content":[{"text":"/**\n * 类功能描述\n *\n * @author lengleng\n * @date ${CURRENT_DATE}\n */","type":"text"}]},{"type":"paragraph","content":[{"text":"如果已有注释但缺少 @author 或 @date","type":"text","marks":[{"type":"strong"}]},{"text":"，补充缺失的标签。","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"3.2 方法注释","type":"text"}]},{"type":"paragraph","content":[{"text":"仅处理","type":"text","marks":[{"type":"strong"}]},{"text":"：","type":"text"},{"text":"public","type":"text","marks":[{"type":"code_inline"}]},{"text":" 和 ","type":"text"},{"text":"protected","type":"text","marks":[{"type":"code_inline"}]},{"text":" 方法","type":"text"}]},{"type":"paragraph","content":[{"text":"跳过","type":"text","marks":[{"type":"strong"}]},{"text":"：","type":"text"}]},{"type":"bullet_list","content":[{"type":"list_item","content":[{"type":"paragraph","content":[{"text":"getter/setter 方法","type":"text"}]}]},{"type":"list_item","content":[{"type":"paragraph","content":[{"text":"@Override","type":"text","marks":[{"type":"code_inline"}]},{"text":" 注解的方法","type":"text"}]}]},{"type":"list_item","content":[{"type":"paragraph","content":[{"text":"private 方法","type":"text"}]}]},{"type":"list_item","content":[{"type":"paragraph","content":[{"text":"已有完整注释的方法","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"如果缺失","type":"text","marks":[{"type":"strong"}]},{"text":"，在方法声明前添加：","type":"text"}]},{"type":"code_block","attrs":{"wrap":false,"language":"java"},"content":[{"text":"/**\n * 方法功能描述\n *\n * @param paramName 参数说明\n * @return 返回值说明\n */","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"3.3 更新日期注释","type":"text"}]},{"type":"table","attrs":{"layout":null},"content":[{"type":"tr","content":[{"type":"th","attrs":{"colspan":1,"rowspan":1,"colwidth":null,"alignment":""},"content":[{"type":"paragraph","content":[{"text":"类型","type":"text"}]}]},{"type":"th","attrs":{"colspan":1,"rowspan":1,"colwidth":null,"alignment":""},"content":[{"type":"paragraph","content":[{"text":"查找模式","type":"text"}]}]},{"type":"th","attrs":{"colspan":1,"rowspan":1,"colwidth":null,"alignment":""},"content":[{"type":"paragraph","content":[{"text":"更新为","type":"text"}]}]}]},{"type":"tr","content":[{"type":"td","attrs":{"colspan":1,"rowspan":1,"colwidth":null,"alignment":""},"content":[{"type":"paragraph","content":[{"text":"@date","type":"text"}]}]},{"type":"td","attrs":{"colspan":1,"rowspan":1,"colwidth":null,"alignment":""},"content":[{"type":"paragraph","content":[{"text":"@date YYYY/MM/DD","type":"text","marks":[{"type":"code_inline"}]},{"text":" 或 ","type":"text"},{"text":"@date YYYY-MM-DD","type":"text","marks":[{"type":"code_inline"}]}]}]},{"type":"td","attrs":{"colspan":1,"rowspan":1,"colwidth":null,"alignment":""},"content":[{"type":"paragraph","content":[{"text":"${CURRENT_DATE}","type":"text","marks":[{"type":"code_inline"}]}]}]}]},{"type":"tr","content":[{"type":"td","attrs":{"colspan":1,"rowspan":1,"colwidth":null,"alignment":""},"content":[{"type":"paragraph","content":[{"text":"Copyright","type":"text"}]}]},{"type":"td","attrs":{"colspan":1,"rowspan":1,"colwidth":null,"alignment":""},"content":[{"type":"paragraph","content":[{"text":"Copyright © YYYY","type":"text","marks":[{"type":"code_inline"}]},{"text":" 或 ","type":"text"},{"text":"Copyright YYYY","type":"text","marks":[{"type":"code_inline"}]}]}]},{"type":"td","attrs":{"colspan":1,"rowspan":1,"colwidth":null,"alignment":""},"content":[{"type":"paragraph","content":[{"text":"${CURRENT_YEAR}","type":"text","marks":[{"type":"code_inline"}]}]}]}]}]},{"type":"paragraph","content":[{"text":"注意","type":"text","marks":[{"type":"strong"}]},{"text":"：","type":"text"},{"text":"@since","type":"text","marks":[{"type":"code_inline"}]},{"text":" 版本号保持不变。","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"4. 输出修改摘要","type":"text"}]},{"type":"paragraph","content":[{"text":"展示每个文件的修改情况：","type":"text"}]},{"type":"bullet_list","content":[{"type":"list_item","content":[{"type":"paragraph","content":[{"text":"添加了多少个类注释","type":"text"}]}]},{"type":"list_item","content":[{"type":"paragraph","content":[{"text":"添加了多少个方法注释","type":"text"}]}]},{"type":"list_item","content":[{"type":"paragraph","content":[{"text":"更新了多少个日期","type":"text"}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"注释规范","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"类注释必需元素","type":"text"}]},{"type":"bullet_list","content":[{"type":"list_item","content":[{"type":"paragraph","content":[{"text":"类功能描述（一句话概括）","type":"text"}]}]},{"type":"list_item","content":[{"type":"paragraph","content":[{"text":"@author","type":"text","marks":[{"type":"code_inline"}]},{"text":" 作者名","type":"text"}]}]},{"type":"list_item","content":[{"type":"paragraph","content":[{"text":"@date","type":"text","marks":[{"type":"code_inline"}]},{"text":" 创建/修改日期","type":"text"}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"方法注释必需元素","type":"text"}]},{"type":"bullet_list","content":[{"type":"list_item","content":[{"type":"paragraph","content":[{"text":"方法功能描述","type":"text"}]}]},{"type":"list_item","content":[{"type":"paragraph","content":[{"text":"@param","type":"text","marks":[{"type":"code_inline"}]},{"text":" 每个参数说明（如有）","type":"text"}]}]},{"type":"list_item","content":[{"type":"paragraph","content":[{"text":"@return","type":"text","marks":[{"type":"code_inline"}]},{"text":" 返回值说明（非 void 方法）","type":"text"}]}]},{"type":"list_item","content":[{"type":"paragraph","content":[{"text":"@throws","type":"text","marks":[{"type":"code_inline"}]},{"text":" 异常说明（如有）","type":"text"}]}]}]},{"type":"hr","attrs":{"markup":"---"}}]},"metadata":{"date":"2026-06-05","name":"code-tidy","author":"@skillopedia","source":{"stars":4,"repo_name":"skills","origin_url":"https://github.com/lltx/skills/blob/HEAD/skills/code-tidy/SKILL.md","repo_owner":"lltx","body_sha256":"18b2839bdccc0b1315eadce9b4520025bb0320fe480c1aabc89174c3a71f0f68","cluster_key":"c33ce28d5390995b263de8478c09154752cf6ccd60463aaaec5c4b5ba7a6e31e","clean_bundle":{"format":"clean-skill-bundle-v1","source":"lltx/skills/skills/code-tidy/SKILL.md","bundle_sha256":"6cfdbb2454b047769a1edd8b5b5ed5fe841886b78ab40ca9910f060970b3c7db","attachment_count":0,"text_attachments":0,"binary_attachments":0},"cluster_size":1,"skill_md_path":"skills/code-tidy/SKILL.md","import_metadata":{"date":"2026-06-05","author":"@skillopedia","version":"v1","category":"software-engineering","category_label":"Engineering"},"exact_dupes_collapsed_into_this":0},"version":"v1","category":"software-engineering","metadata":{"author":"lengleng","version":"1.4.0"},"import_tag":"clean-skills-v1","description":"整理 Java 代码。对 Git 未提交的 Java 类和方法添加/补充 Javadoc 注释，更新日期注释。当用户说\"整理代码\"、\"添加注释\"、\"更新日期注释\"时触发。","argument-hint":["project-dir"]}},"renderedAt":1782979385637}

Important: agents should read /llm.txt, /llms.txt, or /.well-known/skills.json to discover the public Skillopedia API.