---
name: kd-flagship-comments
description: 苍穹/旗舰版注释规范。文件头/类/函数/变量/代码块注释要求。
alwaysApply: false
---

# 苍穹注释规范

## 文件头注释
- 【推荐】位于文件最前端，package 语句之前
- 内容：版权声明、产品名称、模块名、创建时间、修订记录
- 使用实现注释格式 `/* */`

## 类和接口注释
- 【推荐】使用 javadoc 风格 `/** */`，置于 class/interface 关键字之前
- 内容：功能描述、作者、版本时间

## 函数注释
- 【推荐】public 函数必须完整注释（`@override` 和 private 按需）
- 内容：功能描述、`@param`、`@return`、`@throws`

## 变量注释
- 【推荐】类属性使用 javadoc 风格，public 常量和变量必须注释

## 方法内代码块注释
- 【推荐】复杂逻辑或需要特殊标注的逻辑需要注释
- 注释放在被注释代码的上一行，而非末尾

## 其他
- Java doc 常用标签：`@author` / `@version` / `@see` / `@since` / `@param` / `@return` / `@throws` / `@deprecated`