"TIPTOP环境架构中的客製索引命名原则"
在TIPTOP环境中,客製化索引的命名规范是确保系统管理和维护的重要组成部分。这一规范旨在提高代码的可读性、可维护性和一致性。以下是详细的命名规则:
1. **栏位(field)名称** 必须遵循 "tic_" 前缀,接着是表格名(去除 "_file"),然后加上三位数字流水号。例如:tic_ima_001 和 tic_ima_002。无论是对现有表的索引进行修改还是创建新表的索引,所有客製化的更改或新增都应遵循这个规则。
2. **模块代码** 在TIPTOPGP中,模块代码由三到五个英文字符组成,具有特定的含义:
- 开头字母 "a" 表示系统基础模块,如 agl, apy, axr, azz。
- "g" 表示针对大陆版修改的模块,如 ggl, gpy, gxr。
- "c" 表示客製化模块,如 cap, cgl。
- 不包括 "lib", "sub", "qry" 这三个系统函数。
3. **作业名称** 定义了操作的类型和流水号:
- 作业名称由模块名称、一个字符的程序类别以及三位数字流水号组成。例如,"I" 表示建档(维护作业),"T" 表示处理(交易处理),"P" 表示批次处理等。
- 流水号用于区分同一模块下的不同作业,只要在同一模块内不重复即可。
4. **作业名称的特殊情况**:
- 子作业的名称通常是在原作业名称基础上添加数字或下划线,如 aimi1001 或 aimi100_a。
- 副程序的名称会以 "s" 开头,如 saimi100。
- AZZ系统的管理模块有例外,如 p_zz 和 p_perlang。
5. **函数名称**:
- 对于lib(库)函数,名称以 "cl_" 开头,如 cl_create_qry() 和 cl_user(),存放在lib(clib)目录下,并在p_link的lib资料中注册。
- sub(子程序)函数以 "s_" 开头,如 s_smyauno() 和 s_chkinvoice(),存放在sub(csub)目录下,需要在p_link的sub资料中注册。
- qry(查询)函数以 "q_" 开头,表示主要查询的表格名称,如 q_table_name,存放在qry(cqry)目录下,并在p_qry中注册。
- 函数名称应清晰易懂,可以用下划线 "_" 连接字符串。
TIPTOPGP的命名原则涵盖了模块、作业和函数的命名规范,这些规范有助于确保代码的一致性和可维护性,是开发和维护TIPTOP环境中的关键要素。通过遵循这些原则,开发人员可以更有效地组织和管理代码,减少错误并提高团队间的合作效率。