alibaba / alibaba/Alibaba-Java-Coding-Guidelines
IDEA插件对变量命名的检测不算太完善
未关闭
- 主要语言
- 没有语言数据
- 星标
- 1.1k
- 派生
- 246
- PR 合并指标
- 30 天内没有已合并 PR
描述
在**阿里巴巴Java开发手册(终极版)**中的 **第六个模块 工程结构** 的 **第一部分 应用分层** 的3中描述了分层领域模型规约。里面有写到xxxAO表示的应用对象。 这是前提1
我们知道在IDEA插件中中对命名一般是需要遵循首字母大写的,但是对于VO,DTO之类结尾的POJO类对象可以命名为xxxVO,xxxDTO不必严格遵守首字母大写的规约。这是前提2
IDEA的编码插件检测变量时会检测出不符合驼峰命名的变量。这是前提3
我的问题是,在IDEA中的编码插件对变量的命名检测不够完善。如:
```java
class NameAO { //类的命名符合规约
private NameAO nameAO; // 但是这个变量的命名符合规约但是插件会给出 **不符合驼峰命名的warning**
}
class NameVO { // 类的命名符合规约
private NameVO nameVO; //这个变量的命名符合规约,插件没有给出warning
```
综上,我认为这是不合理的,插件在对nameAO的命名中不应该给出警告。
贡献指南
这个仓库没有索引到贡献指南
调研方向
使用 issue 中描述的 NameAO/nameAO 和 NameVO/nameVO 示例复现 IDEA 命名检查,并比较警告。当该检查能够按照所述命名约定一致地接受 AO 变量命名,并且现有的 VO/DTO 行为仍然正确时,这项工作即完成。
由索引模型根据 Issue 内容生成。
评估
- 技术栈
- java
- 领域
- tooling
- Issue 类型
- 缺陷
- 难度
- 4/5
- 预计耗时
- 3-5 天
- 活跃度
- 停滞
- 描述清晰度
- 基本清楚
- 新手友好度
- 35/100