2017《面向对象程序设计》课程作业二

2017《面向对象程序设计》课程作业二

林燊 031602325 https://www.cnblogs.com/linshen/

github链接：https://github.com/Travaill/Cppwork2.git

1.设计思路

2.程序功能

  • 计算圆的面积

3.算法分析

  • 类CCalculator 计算面积

4.代码规范

  • 源文件头部应进行注释，列出：生成日期、作者、模块目的/功能等。

    示例：  
    下面这段源文件的头注释比较标准，可以不局限于此格式，但上述信息要包含在内。    
    说明：Description一项描述本文件的内容、功能、内部各部分之间的关系及本文件与其它文件关系等。

    /************************************************************

    FileName: test.cpp

    Author:

    Version :

    Date:

    Description:     // 模块描述

    Version:         // 版本信息

    Function List:   // 主要函数及其功能

    1. -------

    History:         // 历史修改记录

    < author >  < time >   < version >   < desc >

    ​ David      96/10/12     1.0     build this moudle   ***********************************************************/

    History是修改历史记录列表，每条修改记录应包括修改日期、修改者及修改内容简述。

    ​

  • 函数头部应进行注释，列出：函数的目的/功能、输入参数、输出参数、返回值等

    示例:

    /*************************************************

    Description:    // 函数功能、性能等的描述

    Input:          // 输入参数说明，包括每个参数的作                  用、取值说明及参数间关系。

    Output:         // 对输出参数的说明。

    Return:         // 函数返回值的说明

    Other          // 其它说明

    *************************************************/

  • 函数名以大写字母开头，采用谓宾结构（动名），且应反映函数执行什么

    操作以及返回什么内容。

  • 类、结构、联合、枚举的命名须分别以C、S、U、E开头，其他部分遵从一般变量命名规范。

  • 一个函数仅完成一件功能

    ​

5.代码展示

/************************************************************
FileName: caculate.cpp    
Author:   lin
Version : 1.0         
Date:     2017.4.27
Description:计算圆的面积     // 模块描述         
Version:         // 版本信息    
Function List:   // 主要函数及其功能     
1.double caculateCircle(int r)  计算圆的面积

History: none        // 历史修改记录    

<author>  <time>   <version >   <desc>       
Lin     2017/4/27     1.0     build this moudle   
***********************************************************/

#include"caculator.h"
#define PI 3.14       //定义常量π为3.14

/*************************************************   
Description: 计算圆的面积     // 函数功能、性能等的描述    
Input:  输入的参数r为圆的半径 // 输入参数说明，包括每个参数的作用、取值说明及参数间关系。   
Output: 输入为圆的面积        // 对输出参数的说明。   
Return: 返回圆的面积          // 函数返回值的说明   
Others: PI为常量3.14          // 其它说明  
*************************************************/
double CCaculator::CaculateCircle(int r)
{
	double s = 0;
	s = PI*r*r;
	return s;
}

6.提交日志

7.个人感受

此次作业比较简单,所以我就把主要的精力放在了学习代码规范上面,至于函数的分离与头文件等等,之前计算器的作业,已经使用此方法进行编码,在这里就不进行赘述了.上面展示的代码第一眼看到,可能觉得注释比代码还多.也可能觉得明明这么简单的程序为什么要写如此多的注释.

因为,项目的开发一般不是由你一个人完成的,所以你的代码要是可读的,易读的,这不仅需要你的变量返回值,函数写的规范且功能单一.还有注释是必不可少的,每个函数的上头加上如上面所示注释,可以大大的提高的函数的可读性.

ps.安装最新版本的VS花了我不少的时间,一直遇到"安装程序清单签名验证失败",如果有同样问题的同学,可以试试这样可以不可以解决
开始-运行-gpedit.msc-计算机配置-Windows 设置-安全设置-本地策略-安全选项-系统机密：将FIPS兼容算法用于加密、哈希和签名-设置禁用-退出安装程序，重新安装一次。

posted @ 2017-04-27 16:33  travail  阅读(182)  评论(0)  编辑  收藏  举报