| |
|
开发:
C++知识库
Java知识库
JavaScript
Python
PHP知识库
人工智能
区块链
大数据
移动开发
嵌入式
开发工具
数据结构与算法
开发测试
游戏开发
网络协议
系统运维
教程: HTML教程 CSS教程 JavaScript教程 Go语言教程 JQuery教程 VUE教程 VUE3教程 Bootstrap教程 SQL数据库教程 C语言教程 C++教程 Java教程 Python教程 Python3教程 C#教程 数码: 电脑 笔记本 显卡 显示器 固态硬盘 硬盘 耳机 手机 iphone vivo oppo 小米 华为 单反 装机 图拉丁 |
-> Java知识库 -> Nissi商城序章(二):制定开发/设计规约 -> 正文阅读 |
|
[Java知识库]Nissi商城序章(二):制定开发/设计规约 |
一、代码规范1.1 命名规范:
1.2 注释规范:
在每个类前面必须加上类注释,注释模板如下:
2. 属性注释 在每个属性前加上属性注释,注释模板如下:
3. 方法注释 在每个方法前必须加上方法注释,注释模板如下:
4. 构造方法注释 在每个构造方法前必须加上注释,注释模板如下:
5. 方法内部注释 在方法内部使用单行或多行注释,该注释根据实际情况添加。 二、数据库设计规范4.1 基本命名原则?规范:字母全部小写原则 所有数据库对象命名字母全部小写,统一大小写有助于在多数据库间转移。 ?规范:字符范围原则 只能使用英文字母、下划线、数字进行命名,且首位字符必须是英文字母。 ?规范:分段命名原则 命名中多个单词间采用下划线分割,以便阅读同时方便某些工具对数据库对象的映射。例如:user_name。 ?规范:不要用保留词 数据库对象命名不能直接使用数据库保留关键字,但分段中可以使用。如user不能用于表名、列名等,但是user_name可以用于列名,user_info也可以用于表名。 ?规范:同义性原则 对于同一含义尽量使用相同的单词命名,不管使用英文单词、英文缩写还是拼音首字母,以免引起误解。如telphone的A表中表示固定电话号码,在B表中就不应该用于表示移动电话号码。尽量避免同一单词表示多种含义的情况。 ?规范:命名方式一致原则在一个系统、一个项目中尽量采用一致的命名方式,都采用英文单词或者拼音首字母。尤其要避免在一个对象命名中同时采用英文单词和拼音首字母。如确实需要在一个项目中采用两种命名方式,考虑系统功能设计相关表(开发)使用英文单词命名,业务相关的表(实施)使用拼音首字母。 4.2 命名前缀规范?规范:以下对象命名采用固定前缀进行命名,前缀表示数据库对象的类型,前缀代码规范如下: 4.3 表和列规范4.3.1 表规范 ?规范:表名采用多段式命名,各单词间用下划线分隔; ?规范:表名只允许用英文字母、下划线、数字进行命名,不允许用中文或者其他符号; ?规范:表名全部字母小写; ?规范:根据历史习惯各系统常用表类前缀作如下约定: ?建议:表名也用于相关索引、分区、分区表空间、约束、主键等命名,因此为了避免相关对象命名长度超过限制,建议表名长度不要超过20。 4.3.2 列规范 ?建议:列名只允许用英文字母、下划线、数字进行命名,不允许用中文或者其他符号。 ?规范:列名字母全部小写。 ?规范:列名采用多段式命名时,各单词间用下划线分隔; ?规范:日期类型字段推荐以“_date”结尾的名字命名,时间类型的字段推荐以“_time”结尾的名字命名。 4.3.3 常用字段规范 ? ? ? |
|
|
上一篇文章 下一篇文章 查看所有文章 |
|
开发:
C++知识库
Java知识库
JavaScript
Python
PHP知识库
人工智能
区块链
大数据
移动开发
嵌入式
开发工具
数据结构与算法
开发测试
游戏开发
网络协议
系统运维
教程: HTML教程 CSS教程 JavaScript教程 Go语言教程 JQuery教程 VUE教程 VUE3教程 Bootstrap教程 SQL数据库教程 C语言教程 C++教程 Java教程 Python教程 Python3教程 C#教程 数码: 电脑 笔记本 显卡 显示器 固态硬盘 硬盘 耳机 手机 iphone vivo oppo 小米 华为 单反 装机 图拉丁 |
360图书馆 购物 三丰科技 阅读网 日历 万年历 2024年11日历 | -2024/11/24 11:02:14- |
|
网站联系: qq:121756557 email:121756557@qq.com IT数码 |