MicroCommunity 开发规范

代码风格规范

代码格式

• 文件长度不超过1500行
• 每行代码不超过150个字符
• 方法长度不超过160行
• 方法参数个数不超过5个
• 使用4个空格缩进，禁止使用Tab

注释规范

• 所有类必须包含Javadoc注释
• 所有方法必须包含Javadoc注释（get/set方法除外）
• 禁止使用魔法数字，0和1除外
• 关键业务逻辑必须添加注释说明

代码质量

• 禁止使用System.out.println
• if语句嵌套不超过3层
• for循环嵌套不超过2层
• 方法中return语句不超过3个
• 必须重写equals和hashCode方法

命名规范

包命名

• 全部使用小写字母
• 格式：^{[a-z]+(.[a-z][a-z0-9])$}

类命名

• 使用大驼峰命名法（PascalCase）
• 接口和类名以名词形式命名

方法命名

• 使用小驼峰命名法（camelCase）
• 方法名以动词形式命名

变量命名

• 局部变量使用小驼峰命名法
• 常量使用全大写，下划线分隔
• 避免使用单个字符命名

文档编写规范

代码文档

• 所有公共API必须包含完整的Javadoc
• 注释内容要清晰描述功能、参数和返回值
• 使用中文注释，便于团队协作

项目文档

• README文件必须包含项目说明和使用方法
• 重要配置变更需要更新相关文档
• 接口文档使用OpenAPI规范

其他规范

版本控制

• 提交信息要清晰描述修改内容
• 禁止提交编译产物和IDE配置文件
• 及时处理代码冲突

异常处理

• try-catch嵌套不超过3层
• 异常信息要明确，便于问题定位
• 合理使用日志记录异常信息