首页 > 编程知识 正文

数据库设计说明书模板(oracle数据库原理)

时间:2023-05-06 13:28:00 阅读:68072 作者:4312

2 .编码规格

功能未完成时一定要写(TODO: ) )。

方法和函数具有注释,注释内容包括实用程序、参数、返回值、作者和样例(如果需要)

逻辑上复杂的代码,重要的部分需要注释

2.1 PHP编码规范

类文件命名ThinkPHP命名约定

公用控制器的名称必须与模块名称相同

默认控制器层控制器

方法命名约定-命名驼峰字,不要显示下划线

类属性规范-类属性和类方法匹配,统一使用驼峰匹配

命名函数-为小写加下划线

变量命名约定-产品与全局变量无关。 局部变量不是必需的。 建议使用下划线

在后台控制器中为列表赋值的所有变量都使用list,使用data读取和存储单个数据。 为了不冲突其他临时变量,最好不要使用这两个

2.2前端编码规范

2.2.1模板文件相关常数

__PUBLIC__公共资源文件目录

__CDN__公共静态文件目录

__IMG__当前模块图像目录

__CSS__当前模块CSS目录

__JS__当前模块JS目录

3数据库规格

必须在所有字段中添加注释

字段名用小写字母分隔,多个关键字用下划线分隔(关键字尽可能全名)。

所有字段都不能包含空值

字段长度定义(TODO:中常用长度定义) ) ) ) ) ) ) ) ) ) ) )。

数据表引擎MyISAM

中的所有表都应该具有用于标记数据状态的status字段。 业务状态请使用其他字段;

~~~

1 .以1. dtree_开头的所有字段都是common_datatree表的ID

2. status字段类型为有符号tinyint

-1已删除

0无效

1正常

2未审查

如果需要其他数据状态,请首先确定该状态的数据是有用数据还是无意义数据

有用的数据状态2

无意义的数据状态-1

的所有删除(清空回收站操作除外)都必须将status标记为-1

3. uID基本上是指用户的id,特殊情况下在字段说明中注明。

4.

~~~

4文档规格

功能模块文档

文件注释

方法注释

函数注释

代码块注释

*评论需要@author项目。 这对于在出现问题时找到和调整作者很有用。 **

版权声明:该文观点仅代表作者本人。处理文章:请发送邮件至 三1五14八八95#扣扣.com 举报,一经查实,本站将立刻删除。