docs: 新增Java方法注释规范到项目开发指南
在CLAUDE.md中添加方法注释规范(Method Comment Standard): - 强制要求所有新增Java文件的方法必须添加注释 - 统一注释格式:@description [功能描述] 和 @author Leocoder - 适用于所有类型的方法(public、private、protected、接口方法等) - 提供具体的示例代码和使用场景 此规范旨在提高代码可读性、可维护性和团队协作效率, 确保项目代码注释的一致性和标准化。
This commit is contained in:
parent
530ae64dd6
commit
6a276f45a9
33
CLAUDE.md
33
CLAUDE.md
@ -14,7 +14,38 @@ DRY (Don't Repeat Yourself):绝不复制代码片段。通过抽象(如函
|
||||
默认语言:请默认使用简体中文进行所有交流、解释和思考过程的陈述。
|
||||
代码与术语:所有代码实体(变量名、函数名、类名等)及技术术语(如库名、框架名、设计模式等)必须保持英文原文。
|
||||
注释规范:代码注释应使用中文。
|
||||
行尾注释禁令 (End-of-Line Comment Prohibition):严格禁止在代码行末尾添加注释(如 `code; // 注释`)。所有注释必须单独占行或作为方法/类的头部注释。这确保代码的简洁性和可读性,避免行尾注释造成的视觉干扰。
|
||||
行尾注释禁令 (End-of-Line Comment Prohibition):严格禁止在代码行末尾添加注释(如 `code; // 注释`)。所有单行注释必须在代码行前面单独占一行,格式为:
|
||||
```java
|
||||
// 设置文件访问路径
|
||||
String fileUploadPath = (String) fileMap.get("fileUploadPath");
|
||||
```
|
||||
这确保代码的简洁性和可读性,避免行尾注释造成的视觉干扰。
|
||||
|
||||
方法注释规范 (Method Comment Standard):所有新增的Java文件中的方法都必须添加方法注释,格式为:
|
||||
```java
|
||||
/**
|
||||
* @description [功能描述]
|
||||
* @author Leocoder
|
||||
*/
|
||||
```
|
||||
此规范适用于:
|
||||
- 所有public方法
|
||||
- 所有private方法
|
||||
- 所有protected方法
|
||||
- 接口方法
|
||||
- 抽象方法
|
||||
- 静态方法
|
||||
|
||||
示例:
|
||||
```java
|
||||
/**
|
||||
* @description [上传文件到阿里云OSS]
|
||||
* @author Leocoder
|
||||
*/
|
||||
public Map<String, Object> uploadFile(MultipartFile file, String fileName, String folderPath) {
|
||||
// 方法实现
|
||||
}
|
||||
```
|
||||
批判性反馈与破框思维 (Critical Feedback & Out-of-the-Box Thinking):
|
||||
审慎分析:必须以审视和批判的眼光分析我的输入,主动识别潜在的问题、逻辑谬误或认知偏差。
|
||||
坦率直言:需要明确、直接地指出我思考中的盲点,并提供显著超越我当前思考框架的建议,以挑战我的预设。
|
||||
|
||||
Loading…
Reference in New Issue
Block a user