数据结构与算法程序设计风格和注释要求.doc

“数据结构与算法”程序设计风格和注释要求 1．诚实代码保证 在“数据结构与算法”课程今后的实习报告中，同学们提交的每个程序都应该遵循Honor Code（诚实代码保证）的要求。 请大家特别注意一定要在每个程序首部的注释中加上以下保证： // 我真诚地保证： // 我自己独立地完成了整个程序从分析、设计到编码的所有工作。 // 如果在上述过程中，我遇到了什么困难而求教于人，那么，我将在程序实习报告中 // 详细地列举我所遇到的问题，以及别人给我的提示。 // 在此，我感谢 XXX, …, XXX对我的启发和帮助。下面的报告中，我还会具体地提到 // 他们在各个方法对我的帮助。 // 我的程序里中凡是引用到其他程序或文档之处， // 例如教材、课堂笔记、网上的源代码以及其他参考书上的代码段, // 我都已经在程序的注释里很清楚地注明了引用的出处。 // 我从未抄袭过别人的程序，也没有盗用别人的程序， // 不管是修改式的抄袭还是原封不动的抄袭。 // 我编写这个程序，从来没有想过要去破坏或妨碍其他计算机系统的正常运转。 // 学生姓名 如果没有在提交程序时加上这段保证，将被认为违背了Honor Code规则。本次上机题记零分或根据抄袭情况倒扣分。 2.内部文档要求 .每个源文件和头文件都必须在文件首部的注释中注明设计者姓名，项目名（即我们的上机题目名），创建日期和最近一次修改日期。包含main()函数的源文件必须在首部注释后另加一段注释,简要描述一下程序的目的和用到的主要数据结构。文件注释格式如下： 文件名称：创建者：创建时间：最后修改时间：功能： 文件中的函数名称和简单功能描述：文件中定义的全局变量和简单功能描述：文件中用到的他处定义的全局变量及其出处：与其他文件的依赖关系：类名称：定义该类的目的：类属性：类中函数及功能：与其他类的关系（调用/被调用哪类对象中的什么函数）：函数名称：函数功能描述：函数的输入参数：函数的输出参数：函数的抽象算法（伪码）： 函数与其他对象中函数的调用和被调用关系：copy constructor），而且写出赋值操作的重载运算（assignment operator overload）。 .仅当有必要时才采用继承机制。 .尽量少使用MFC库中的类，可以适当地使用STL的类（但是，如果同学们对于最基本的数据结构，例如栈、队列等还不熟悉的情况下，还是尽量自己来编写基本类）。如果要编图形界面，请尽量把与编译环境（如VC、C++ Builder）有关的类限制在少数几个文件中。也就是说，尽量把算法部分和界面部分的源程序分割开来。当然，string类例外，大多数情况下同学们可以用它来替代chat*类型。