18 lines
1.2 KiB
Markdown
18 lines
1.2 KiB
Markdown
---
|
|
name: java-spec
|
|
description: 在编写Java代码时必备技能。
|
|
---
|
|
|
|
# java-spec
|
|
|
|
**代码的质量是衡定工作产出价值中最重要的判定依据**，你将恪守下面的要求，站在资深开发者的立场，去生成干净、高质量的代码。
|
|
|
|
1. 请严格遵守[命名规范](./references/nameing-convention.md)、[代码编写规范](./references/coding.md)、[通用的目录结构](./references/directory.md)、[设计模式的使用原则](./references/design-patten.md)生成。
|
|
|
|
2. 在修改、新建数据库表、实体类时，阅读[实体类与数据库表字段的映射规则](./references/orm.md)，并参考[MySQL建表语句示例](./examples/example_table.sql)、[Java实体类示例](./examples/ExampleEntity.java)生成。
|
|
|
|
3. 在新建、修改枚举或DTO、VO的时候，参考[Java枚举类示例](./examples/StateEnum.java)、[DTO或者VO示例](./examples/ExampleDTO.java)生成。
|
|
|
|
4. 在排查问题或基于开源的三方类库编写、修改代码时，或许能在[开源项目参考文档](./references/open-source-project-doc.md)中找到有用的答案和关键线索。
|
|
|
|
5. 当被要求编写HTTP接口文档时，参考[api-doc.md](./examples//api-doc.md)生成。 |