C#培训2019-10-15第一课 注解 流程图

版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。

本文链接： https://blog.csdn.net/qq_41617697/article/details/102589227

1、注解与流程图

一般看别人的程式，会首先看注解，跟着注解去理解程式。因此注解的重要性不言而喻。
而当看完注解，对整个程式还不够了解时，会查看流程图。

因此：流程图中写的是相对重要、核心的东西。相对不重要的可以不写，例如初始化、检查输入是否合法等。

目的是，看流程图不用看程式，可以知道核心怎么实现的。

注：流程图要和注释部分顺序要一一对应！！！注释可以多注释，但是流程图中的项目在注释中一定要能找到，而且顺序要和流程图对应起来！！！！！

2、注解

①注解量

程序推荐注解的数量为程序的三层

②注解的质量要高，不能就是讲程序内容翻译一遍

例如经常用的CheckInputValid的方法名，来判断输入是否合理：
在调用时的注解可以写作：

// check input is valid
CheckInputValid(txtInput1.Text);

但是在方法定义时，必须写清楚不合法的规则是什么

// Input must be positive integer
bool isValid CheckInputValid(string szInput){

}

例如删除不需要的数
在调用方法时可以注释：删除/舍去 不用的数字
但是在定义方法时，要写作：删除的规则具体是什么

另：按钮的 Enable/Disable 操作，需要注解为什么