源代码说明文档

以下是博文学习网为大家整理的关于源代码说明文档的文章,希望大家能够喜欢!

源代码说明文档篇一：源代码使用说明

1．本书1~20章所附代码的运行环境

操作系统：Windows 2003、Windows XP Professional，或者Windows 2000

开发环境：Microsoft Visual C++ 6，个别代码需要Microsoft VC++ 2005，已说明

说明：本书所有代码均严格遵照2003年ISO/ANSI C++标准，读者可不做修改，直接将程序移植到其他开发环境下使用。 光盘使用说明使用

2．本书所附光盘范例

第1章（\chap1）

示例描述：本章演示如何开始使用C++进行程序的开发。

HelloWord

第2章（\chap2）

示例描述：本章介绍C++语言的基本语素。

MultiplyTwoNumber

DefineAVariable

CharSample1

CharSample2

CharSample3

Square1

Square2

Enum

Shift Arithmetic

BitLogic

简单示例如何编写两个整数相乘的C++程序。 定义一个变量并对其赋值。 AnotherMultiply2Number 两数相乘的另一种写法。 单字符常量和双字符常量的用法。 字符型常量的数值形式。 字符型的算术运算。 计算边长为4.0的正方形的周长与面积。 符号常量的声明与使用。使用枚举常量。 算术运算符和算术表达式的用法示例。第一个用C++开发的Windows应用程序。 移位运算的用法。 位逻辑运算用法示例。 复合赋值运算符的用法。 自增/自减运算符的前缀形式和后缀形式。 逗号表达式的用法。 赋值转换：较大整型转换为较小整型。 类型转换：浮点型转换为整型。 较大的浮点型转换为较小的浮点型

CompoundAssign PrefixAnd(来自:www.hnnSCY.cOm 博文学习 网:源代码说明文档)Postfix CommaAssigmentConversion1 AssigmentConversion2 AssigmentConversion3

AssigmentConversion4

Conversion

IfElse1

IfElse2

IfElse3

类型转换：整型转换为浮点型。 显式转换中的数据丢失。 if…else选择结构。 if…else?结构嵌套。 if?结构。 switch结构的用法。 break在switch中的应用。 多个case标签共用一个语句。for循环结构。 for循环结构嵌套。 SwitchSample1 BreakInSwitch SwitchSample2 ForSample1 ForSample2WhileSample BreakSample ContinueSample GotoSample Terminate

第3章（\chap3）while循环结构。 流程转向语句break的用法。 流程转向语句continue的用法。 自由转向语句goto的用法。 程序中止函数exit()的用法。

示例描述：本章学习数组和字符串的相关内容。

ArraySample1

ArraySample2

ArraySample3

GetC-String

CinAndGet

使用一维数组计算平均成绩。 声明一个数组的同时对其初始化。 寻找数组的最大值和最小值。 C风格字符串的输入输出。 函数get()和getline()的用法。 cin与get()/getline()函数的搭配。 InputAndOutputAC-String ElementAccess 访问C风格字符串中的某个元素。 C风格字符串处理函数使用范例。 多维数组：将二维数组中的数据关于对角线互换。 C-StringFunctionSample TwoDimentionArray

第4章（\chap4）

示例描述：本章学习指针的引用的用法。

PointerSample

SizeofPointer

PointerOperation

OperatorNew

OperatorDelete

MallocAndFree

ArrayName

PointerToArray

指针变量的值及其占用的字节数。 指向不同类型的指针变量占用相同的内存字节数。 不同类型的指针间的赋值。 同类型指针相减。 使用new申请动态内存。 使用或释放已经释放的内存的后果。 使用malloc()和free()申请和释放动态内存。 数组名指针。 指向数组的指针。 使用普通指针变量访问多维数组。 使用数组名式指针变量访问多维数组。 使用指针数组处理字符串。

PointerAssignment PointerToMultiDArrray1 PointerToMultiDArrray2 ArrayofPointer

套光盘使用说明

TwoDimensionCharArray

Reference

第5章（\chap5）使用二维char型数组管理字符串。 对引用的赋值和取址操作。

示例描述：本章学习结构、共用体和链表的相关内容。

StructSample

声明一个结构变量并对其中成员进行访问。结构变量的初始化。 共用体和结构的不同。 结构变量间的赋值操作。 共用体使用举例。 为结构指针动态分配内存。使用指针访问结构成员。 同质链表的创建。 InitialofStructVariable UnionAndStruct UnionSample StructAndNew CreateAListAssignmentBetweenVariables StructMemberAccess ListOperation InsertANode RemoveANode

第6章（\chap6） 链表的遍历和查找。 链表结点的插入。 链表结点的删除。

示例描述：本章学习C++语言面向过程编程的核心：函数。

FunctionSample

VoidFunction

MultiFile

使用函数的3个步骤。 void型函数的用法。 多个文件组织成一个程序。 函数形参和实参的关系。 传递参数时的自动类型转换。 传递参数之传值调用。 传递参数之传指针调用。 传递参数之传引用调用。 函数返回某个值的3种方式。 函数的缺省参数调用。 inline函数的用法。 递归演示：计算某个正整数的阶乘。 函数重载范例。 无法编译通过的函数重载。 全局变量的用法：定义性声明和引用性声明。 静态变量的应用。 内部静态变量应用。 演示了同名实体的屏蔽现象。 在某代码块内对全局变量进行引用声明。 ParameterAndArgument AutoConversion CallByValue CallByRefCallByPointer ReturnMethods InlineFunction FactorialDefaultParameters FunctionOverload1 FunctionOverload2 GlobalVariable StaticVariable1 StaticVariable2 IDShield

第7章（\chap7）GlobalVariableAccess

示例描述：本章学习函数与指针、数组的混合应用及其他一些高阶内容。

PointerToTemp 返回指向临时变量的指针。

ModifyConstant

AboutSizeof

ByPointer

试图修改常量引发内存错误。 操作符sizeof用法。 指针传递同样依赖“副本”。 使用指向指针的指针申请内存。 函数返回时的“副本”。 返回指向静态存储区的指针。 函数指针的用法。使用typedef简化函数指针声明。 函数指针作另一函数的参数。 PointerToPointer AboutReturn SpecialPointer UseTypedef PointerToFunction PointerToFuncSample ArrayofFuncPointers ReturnFuncPointer CallByArrayCallByMultiDArray CallByPointerSample CallByStructVariable AboutConst

第8章（\chap8）函数指针数组。 返回函数指针的函数。 数组作函数参数。 多维数组作函数参数。 通过指针参数修改多个变量的值。 结构变量作函数的参数。 const与函数返回值。

示例描述：本章学习C++面向对象程序设计的基础：类和对象。

DefineAClass

定义一个computer类。 在类定义时实现成员函数。 在类定义之外定义成员函数。 使用类声明一个对象。 有参构造函数。 构造函数重载与无参构造函数。 成员初始化表的用法。 用析构函数实现对象动态内存的释放。复制构造函数调用机制。 使用缺省复制构造函数会出现的问题。 DefineAndImplement1 DefineAndImplement2 ClassVariable Constructor1 Constructor2 Constructor3 DestructorCopyConstructor ProblemOfCopyConstructor ConstMember1 ConstMember2 RefMember ClassMember1 ClassMember2 StatciMember DefineOwnCopyConstructor 显式定义复制构造函数。 在构造函数体内无法初始化const数据成员。 使用成员初始化表达式初始化const数据成员。 引用数据成员的初始化。 类对象成员的初始化。 类对象的构造函数隐式调用。 static数据成员的用法。 静态成员函数的用法。 const成员函数的用法。 const对象的用法。 对象的大小。 单个对象动态内存分配。 对象数组动态空间管理。

StaticFuncMembe ConstFuncMember ConstObject SizeofObject NewforObject NewforObjectArray

套光盘使用说明

第9章（\chap9）

示例描述：本章演示如何友元及运算符重载等与对象相关的内容。 VariableAccess

ClassInBlock

MemberFriend

FriendClass

数据成员、形参和全局变量作用域的不同，屏蔽现象。 public嵌套类定义。 类的作用域局限在一个块内。 非成员函数形式的友元。 成员函数形式的友元。 友元类的用法。 以成员函数形式重载运算符。 以友元函数形式重载运算符。 赋值运算符重载。 函数调用运算符重载。 下标运算符重载。 由其他类型转换到自定义类型。 由自定义类型转换为其他类型。 PublicClassSample NonMemberFriend OperatorOverload1 OperatorOverload2 AssignmentOverload FuncCallOverload SubscriptOverload Conversion1 Conversion2

第10章（\chap10）

示例描述：本章讨论面向对象设计的一个重要方面：继承。 InheritanceSample

MultiBaseProblem

CommonBase

VirtualBase

CallSequence

演示了什么是继承。 多基派生时的二义性问题。 多基继承时的共同基类。 虚基派生的用法。 说明了派生类构造函数的调用顺序。 派生类的析构函数。 虚基派生的构造函数和析构函数。 类型适应示例。 DerivedDestructorTypeSample

第11章（\chap11）VirtualConstructorDestructor

示例描述：本章讨论面向对象设计的另一个重要方面：多态。 VirtualProblem

问题引入，不使用虚函数。 使用指针访问虚函数。 使用引用访问虚函数。 类内成员函数访问虚函数。 CallVirtualFuncByNameCallVirtualFuncByPointer CallVirtualFuncByRefPureVirtualFuncSampleAbstractClass ProtectedConstructor PrivateConstructorImproperDestructorVirtualDestructorVirtualFuncAccess 使用对象名访问虚函数。 CallVirtualFuncInsideClass 纯虚函数使用举例。 抽象类的应用。 protected型构造函数的用法。 private型构造函数的用法。 析构函数调用不当导致内存泄露。 使用虚析构函数解决内存泄露问题。

虚函数访问方式。

源代码说明文档篇二：源代码及说明书修改步骤

一、 源代码修改步骤

? 删除页眉和页脚；

? 添加页眉：页眉要居左显示，不能出现拐行，如果没有下横线，则要自行添加；添加页眉方式为：设计—页码—页面顶端—普通设计3；页码页眉标准格式为：软件名称版本号，例如：网站内容管理系统V1.0；页眉内容要与申请表内容一致；

? 每页空行不能超过5个；

? 代码的注释不能出现：公司名称，人名，日期，软件名称，网址，copyright，版权以及与本软件无关的内容。

? 源代码第1页为开始，第31页也是开始，最后一页为完整结束； ? 申请表上源代码数高于3000行，则代码必须为60页；如果低于3000行，修改完成代码要与申请表上的行数一致。

? 如果客户提供的源代码不足，则自行挑选代码片段进行补充，切记选择整段代码进行粘贴复制；要保证无痕迹，不能被看出有复制迹象；

? 修改完成后重新检查整个文档出现的软件名称，版本号要与申请表一致；确保整篇文档不存在一下内容：“公司名称，人名，日期，网址，版权，copyright，技术支持，版权归属，权利归属”等字样。

二、 说明书修改标准步骤

? 删除页眉和页脚；

? 添加页眉：页眉要居左显示，不能出现拐行，如果没有下横线，则要自行添加；添加页眉方式为：设计—页码—页面顶端—普通设计3；页码页眉标准格式为：软件名称版本号，例如：网站内容管理系统V1.0；页眉内容要与申请表内容一致；

? 字体大小为四号或小四号；

? 说明书文字内容不能出现：公司名称或国家相关部门有关的文字内容；不能出现：“网址，版权。”如果出现则需要删除。

? 图片要先复制到画图工具中去，然后放到作图工具上进行修改； ? 图片上面的软件名称及版本号要与申请表上一致；图片上面不能出现其他公司名称，版权归属，人名，日期；图片上面不能出现网址；图片上面不能出现国家相关部门名称；

? PS过程要细致认真，确保不能被看出来；

? 如果有设计文档则要玉说明书整合，设计文档在前，说明书在后； ? 说明书不能超过60页，多余内容要从后删除；

? 说明书图片如果是网页截图，网页上的名称与申请表不一致，则要替换成“网页浏览器框”截图；修改后的图片要保持清晰像素； ? 修改完成以后，检查文字内容和图片内容以确保：名称版本号与申请表一致，无其他公司名称，人名，日期，相关国家部门，版本归属等字样；

? 在开发完成日期前的日期均不能出现，开发完成后的日期可以保留；

? 不能出现logo标识等字样；出现个人照片时应删除。

源代码说明文档篇三：源程序说明书

源程序说明书

1.概述

简要描述该程序在组件中的作用、与其它程序（或类）的关系（可用图来描述）。

2.功能描述

详细描述此程序要完成的功能

3.输入说明

说明程序的输入、媒体文件、运行数据记录、运行开始时使用的输入数据的类型和存放单元、与程序初始化有关的入口要求等。

4.对象类说明

说明该程序中的所有类（类图，每个类的属性及方法。）及每个类所属物理文件的清单（包括文件存放路径）。

5.处理过程说明

用图表说明程序的运行的逻辑流程、程序主要转移条件、对程序的约束条件、程序结束时的出口要求、与下一个程序的通信与联结（运行、控制）、由该程序产生并供处理使用的

输出数据的类型和存放位置等。

6.输出说明

说明程序的输出。

7.接口说明

本程序与其他系统或模块的接口说明（使用到的外部接口及对外提供的接口）。

8.操作环境说明

列出支持该程序运行的数据，及软件（包括名称和版本号）。

9.程序清单和流程图

引用资料或提供附录给出程序清单和流程图。