团队作业2 代码规范及编码原则
目录
- 代码规范及编码原则
- 数据库设计
- ER图
- 主要功能流程描述
- 界面截图
- 任务分工以及比例
代码规范及编码原则
一、程序风格： 1、严格采用阶梯层次组织程序代码 每层次缩进为4格，括号位于下一行。要求相匹配的大括号在同一列，对继行则要求再缩进4格 2、提示信息字符串的位置 在程序中需要给出的提示字符串，为了支持多种语言的开发，除了一些给调试用的临时信息外，
其他所有的提示信息必须定义在资源中。 3、对变量的定义，尽量位于函数的开始位置。
二.命名规则 (1) 变量名的命名规则； 分析：变量名的命名规则遵循用户自定义标识符命名规则 （1） 只能由字母、数字、下划线组成； （2） 第一个字符必须是英文字母； （3） 有效长度为255个字符； （4） 不可以包含标点符号和类型说明符%,&,!,# ,@,$； （5） 不可以是系统的关键词比如else
三.注释 1. 注释要简单明了。 2.边写代码边注释，修改代码同时修改相应的注释，以保证 注释与代码的一致性。 3.在必要的地方注释，注释量要适中。注释的内容要清楚，明了，含义准确，防止注释 二义性。
保持注释与其描述的代码相邻，即注释的就近原则。 4.对代码的注释应放在其上方相邻位置，不可放在下面。 5.对数据结构的注释应放在其上方相邻位置，不可放在下面；对结构中的每个域 的注释应放在此域的右方；
同一结构中不同域的注释要对齐。 6.变量、常量的注释应放在其上方相邻位置或右方。 7.全局变量要有较详细的注释，包括对其功能、取值范围、哪些函数或过程存取它以及存取时注意事项等的说明。 8.在每个源文件的头部要有必要的注释信息，包括：文件名；版本号；作者；生成日期；
模块功能描述（如功能、主要算法、内部各部分之间的关系、该文件与其它文件关系等）；
主要函数或过程清单及本文件历史修改记录等。 9.在每个函数或过程的前面要有必要的注释信息，包括：函数或过程名称；功能描述；
输入，输出及返回值说明；调用关系及被调用关系说明等。
四。可读性 1.避免使用不易理解的数字，用有意义的标识来替代。 2.不要使用难懂的技巧性很高的语句。 3.源程序中关系较为紧密的代码应尽可能相邻。
五.函数，过程 1.函数的规模尽量限制在200行以内。 2.一个函数最好仅完成一件功能。 3.为简单功能编写函数。 4.函数的功能应该是可以预测的，也就是只要输入数据相同就应产生同样的输出。 5.尽量不要编写依赖于其他函数内部实现的函数。 6.避免设计多参数函数，不使用的参数从接口中去掉。 7.用注释详细说明每个参数的作用、取值范围及参数间的关系。 8.检查函数所有参数输入的有效性。 9.检查函数所有非参数输入的有效性，如数据文件、公共变量等。 10.函数名应准确描述函数的功能。 11.避免使用无意义或含义不清的动词为函数命名 12.函数的返回值要清楚、明了，让使用者不容易忽视错误情况。 13/明确函数功能，精确（而不是近似）地实现函数设计。 14.减少函数本身或函数间的递归调用。 15.编写 可重入函数时，若使用全局变量，则应通过关中断、信号量（即P、V操作）等手段对其加以保护。
五.变量编辑
1.去掉没必要的公共变量。 2.构造仅有一个模块或函数可以修改、创建，而其余有关模块或函数只访问的公共变量，防止多个不同模块或函数都可以修改、创建同一公共变量的现象。
3.仔细定义并明确公共变量的含义、作用、取值范围及公共变量间的关系。
4.明确公共变量与操作此公共变量的函数或过程的关系，如访问、修改及创建等。 5.当向公共变量传递数据时，要十分小心，防止赋与不合理的值或越界等现象发生。 6.防止局部变量与公共变量同名。 7.仔细设计结构中元素的布局与排列顺序，使结构容易理解、节省占用空间，并减 少引起误用现象。 8.结构的设计要尽量考虑 向前兼容和以后的版本升级，并为某些未来可能的应用保留余地（如预留一些空间等）。 9.留心具体语言及编译器处理不同数据类型的原则及有关细节。 10.严禁使用未经初始化的变量。声明变量的同时对变量进行初始化。 11.编程时，要注意数据类型的 强制转换。
六。代码编译 1.编写代码时要注意随时保存，并定期备份，防止由于断电、硬盘损坏等原因造成代码丢失。 2.同一项目组内，最好使用相同的编辑器，并使用相同的设置选项。 3.合理地设计软件系统目录，方便开发人员使用。 4.打开编译器的所有告警开关对程序进行编译。 5.在同一项目组或产品组中，要统一编译开关选项。 6.使用工具软件对代码版本进行维护。
对于软件规范我们有话说
1600802087 吕青霞 代码规范十分重要，写的规范，可以减少错误的发生。在团队合作中代码规范显得尤为重要，别人能看懂代码这是十分重要。 尤其在结对编程中，别人能看懂代码显得尤为重要，这样可以减少时间，提高效率。 可以有更加长的时间在软件编程中，所以，代码尽可能写得规范，还是很重要的。在运行过程中，如果写错了，代码规范还可以减少你找错误的时间，提高效率。
1600802078 高亚晴 按照代码规范来写可以不需要浪费多余的空间，在企业工作中可以减少成本。也使得程序运行速度更快。规范的代码具有良好的可读性，方便自己查找错误，更改内容。条理清晰使得他人可以更好的看懂。
代码规范有利于团队合作，
能更好的完成项目。养成良好的y代码规范习惯会让程序员有更好的逻辑能力。
1600802088 吕晓姣 我认为代码规范很重要。自己所写的代码不能仅仅让自己看懂，还需要让别人也能看明白。比如对一个变量或者方法的命名，写一个便的符号自己一开始可能还能明白，但时间久了，自己都忘记是啥了，
更不用说别人。还有代码的缩进，合理的缩进会使得代码看起来更清晰，更有条理。所以代码规范有利于对代码的管理，检查及修改。
1600802100 严香仲 关于代码规范，我觉得我们平时写的时候就应该注意，自己平时写时可能不大注意，但是和团队一起合作项目时，代码的规范就非常的重要，尤其是缩进，缩进可以直接看出哪一行语句属于哪个函数，
如果不规范代码，就会显得很乱，查看看起来浪费时间。团队其他人员也不能清晰明了的看出代码的功能。总之我觉得编写代码的时候就该进行代码规范，而不必等到写完代码后再去慢慢进行代码规范。
数据库设计
ER图
主要功能描述
界面截图（一部分）
任务分工及其比例
| 学号以及姓名 | 任务分工 | 贡献分数 |
| 1600802078 高亚晴 | 数据库以及主要功能描述 | 10.2 |
| 1600802087 吕青霞 | er图，代码原则，文本撰写以及小组分工 | 10.2 |
| 1600802088 吕晓姣 | 部分功能及设计 | 10.3 |
| 1600802100 严香仲 | 部分功能及设计 | 10.3 |
