Java 评审规则:分来源保存
保存日期:2026-11-13。本目录保存可追溯的 Java 规则资料,供人工、Claude Code 或 OCR 评审时选用。当前收录 Google Java Style Guide。
文件入口
| 文件 | 用途 |
|---|---|
| google-styleguide.md | 中文阅读说明与规则要点,按上游章节组织;不是逐句翻译 |
| 完整英文原文 | 固定版本的 javaguide.md,按原始字节保存,包含全部正文、示例、例外和原章节编号 |
| 上游 README | 原仓库说明及文字、代码示例的分别授权声明 |
| sources.lock.json | 完整提交 SHA、固定来源 URL、Git blob SHA-1、SHA-256 和字节数 |
| CC BY 3.0 | 指南文字的上游许可证原文 |
| Apache 2.0 | 代码示例适用的许可证全文 |
来源版本
- 仓库:google/styleguide(原始出处:
https://github.com/google/styleguide)。 - 上游分支:
gh-pages。 - 固定提交:
52f2e7406a802778e44b92694d4aead252b09091。 - 输入文件:javaguide.md(原始出处:
https://github.com/google/styleguide/blob/52f2e7406a802778e44b92694d4aead252b09091/javaguide.md)。 - 官方网页:Google Java Style Guide,此链接会随上游更新,复核本次副本请使用固定提交链接。
范围是 Google 仓库中的 Java 指南,不包括该仓库的其他语言指南。英文快照保持原始内容,因此保留了上游网站目录模板标记和链接;上游 README 中其他语言的相对链接需回到原仓库访问。
用于代码评审
Google Java Style 主要覆盖源码结构、格式、命名、编程惯例和 Javadoc。它可以补充现有 Java 代码审查规范(原始资料路径:../java-code-review.md),但不覆盖完整的业务正确性、事务一致性、资源生命周期、并发和安全审查。
- 先确认目标项目的 JDK、语言级别、现有格式化工具和编码约定。上游当前版本包含较新语言特性,不应因此要求旧版本项目升级语言或改用无法编译的写法。
- 只有项目已经采用 Google Style 时,才把对应的格式和命名要求作为项目规范违规;尚未采用时,作为可选风格参考。
- 中文要点用于快速定位,详细例外、可选写法和规范强度以同目录固定版本英文原文为准。上游明确说明示例是非规范性的,不能把示例中的每个选择都变成强制规则。
- 格式问题优先交给现有格式化或检查工具;评审意见区分实际缺陷、项目规范违规和风格建议,并说明位置、依据及影响。
给 Claude Code 使用的示例:
text
对目标 Java 项目进行代码评审,先读取项目 AGENTS.md 和构建配置。
代码质量使用 idps-docs/common/java-code-review.md。
Google Style 补充参考 idps-docs/common/java-review-rules/google-styleguide.md,
需要确认例外或原文时读取 upstream/google-styleguide-original.md。
遵守项目实际 Java 版本与已有规范;未采用的风格要求只作建议。
报告每项的文件行号、依据、实际影响和最小修改建议。这些文件是参考资料,不会自动安装 skill、修改 OCR 配置或执行扫描。
归属与许可
原始指南由 Google 及其贡献者提供。根据固定版本上游 README 的 Licensing 声明,指南文字采用 CC BY 3.0,代码示例采用 Apache 2.0。对应声明和许可证全文均已保留。
google-styleguide.md 是本次中文归纳:压缩正文、保留主要条件和例外、增加本地评审使用说明,不是 Google 官方中文译文,也不表示 Google 对本项目的认可。本 README 与该中文归纳的文字按 CC BY 3.0 提供;原始快照不作修改。本目录许可说明不改变其他 IDPS 文档或代码的许可。