📄 edu7.htm
字号:
<HTML><HEAD><META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=gb_2312-80"><META NAME="Generator" CONTENT="Microsoft Word 97"><TITLE>第7章 代码的注释</TITLE></HEAD><BODY><DIR><DIR><DIR><DIR><DIR><DIR><DIR><FONT FACE="黑体" LANG="ZH-CN" SIZE=4><P ALIGN="JUSTIFY">代码的注释</P></DIR></DIR></DIR></DIR></DIR></DIR></DIR></FONT><FONT FACE="宋体" LANG="ZH-CN"><P ALIGN="JUSTIFY">使用代码注释的目的:</P><OL TYPE="a"><P ALIGN="JUSTIFY"><LI>用文字说明代码的作用(即为什么要用编写该代码,而不是如何编写);</LI></P><P ALIGN="JUSTIFY"><LI>明确指出该代码的编写思路和逻辑方法;</LI></P><P ALIGN="JUSTIFY"><LI>使人们注意到代码中的重要转折点;</LI></P><P ALIGN="JUSTIFY"><LI>使代码的阅读者不必在他们的头脑中仿真运行代码的执行过程.</LI></P></OL><P ALIGN="JUSTIFY"></P><P ALIGN="JUSTIFY">1.编程原则:</P><P ALIGN="JUSTIFY"> (1)用文字说明代码的作用:</P><DIR><P ALIGN="JUSTIFY"> 简单的重复代码做写什么,这样的注释几乎不能给注释增加什么信息.如果你使用好的命名方法来创建直观明了的代码那么这些类型的注释绝对增加不了什么信息.</P><P ALIGN="JUSTIFY"></P></DIR><P ALIGN="JUSTIFY">(2)如果你想违背好的编程原则,请说明为什么</P><DIR><P ALIGN="JUSTIFY">有的时候你可能需要违背好的编程原则，或者使用了某些不正规的方法，.遇到这种情况时,请用内部注释来说明你在做什么和为什么要这样做。</P><P ALIGN="JUSTIFY">		技巧性特别高的代码段，一定要加详细的注释，不要让其他开发人员花很长时间来研究一个高技巧但不易理解的程序段。</P><P ALIGN="JUSTIFY"></P></DIR><P ALIGN="JUSTIFY">(3).用注释来说明何时可能出错和为什么出错</P><P ALIGN="JUSTIFY">	</P><P ALIGN="JUSTIFY">(4)在编写代码前进行注释</P><DIR><P ALIGN="JUSTIFY"> 给代码加注释的方法之一是在编写一个过程前首先写上注释.如果你愿意,可以编写完整句子的注释或伪代码.一旦你用注释对代码进行了概述,就可以在注释之间编写代码.</P><P ALIGN="JUSTIFY"></P><P ALIGN="JUSTIFY">(5)在要注释的代码前书写注释</P><P ALIGN="JUSTIFY">		注释一定出现在要注释的程序段前，不要在某段程序后书写对这段程序的注释，先看到注释对程序的理解会有一定帮助。</P><P ALIGN="JUSTIFY">		如果有可能，请在注释行与上面代码间加一空行。</P><P ALIGN="JUSTIFY"></P></DIR><P ALIGN="JUSTIFY">(6)纯色字符注释行只用于主要注释</P><P ALIGN="JUSTIFY">		注释中要分隔时，请使用一行空注释行来完成，不要使用纯色字符，以保持版面的整洁、清晰。</P><P ALIGN="JUSTIFY"></P><P ALIGN="JUSTIFY">(7).避免形成注释框</P><DIR><P ALIGN="JUSTIFY"> 用星号围成的注释框，右边的星号看起来很好,但它们给注释增加了任何信息吗?实际上这会给编写或编辑注释的人增加许多工作。</P><P ALIGN="JUSTIFY"></P></DIR><P ALIGN="JUSTIFY">(8)使用撇号来指明注释</P><P ALIGN="JUSTIFY">		不要使用Rem语句来注释。</P><P ALIGN="JUSTIFY"></P><P ALIGN="JUSTIFY">(9).增强注释的可读性</P><P ALIGN="JUSTIFY">注释是供人阅读的，而不是让计算机阅读的。</P><OL TYPE="a"><OL TYPE="a"><OL TYPE="a"><P ALIGN="JUSTIFY"><LI>使用完整的语句。虽然不必将注释分成段落（最好也不要分成段落），但你应尽量将注释写成完整的句子。</LI></P><P ALIGN="JUSTIFY"><LI>避免使用缩写。缩写常使注释更难阅读，人们常用不同的方法对相同的单词进行缩写，这会造成许多混乱，如果必须对词汇缩写，必须做到统一。</LI></P><P ALIGN="JUSTIFY"><LI>将整个单词大写，以突出它们的重要性。若要使人们注意注释中的一个或多个单词，请全部使用大写字母。</LI></P></OL></OL></OL><P ALIGN="JUSTIFY"></P><P ALIGN="JUSTIFY"> （10）对注释进行缩进，使之与后随的语句对齐。</P><DIR><DIR><DIR><P ALIGN="JUSTIFY"> 注释通常位于它们要说明的代码的前面。为了从视觉上突出注释与它的代码之间的关系，请将注释缩进，使之与代码处于同一个层次上。</P><P ALIGN="JUSTIFY"></P></DIR></DIR></DIR><P ALIGN="JUSTIFY"> （11）为每个过程赋予一个注释标头</P><DIR><DIR><DIR><P ALIGN="JUSTIFY"> 每个过程都应有一个注释标头。过程的注释标头可包含多个文字项，比如输入参数、返回值、原始作者、最后编辑该过程的程序员、上次修改日期、版权信息。</P><P ALIGN="JUSTIFY"></P></DIR></DIR></DIR><P ALIGN="JUSTIFY"> （12）当行尾注释用在上面这种代码段结构中时，它们会使代码更难阅读。</P><P ALIGN="JUSTIFY"> 使用多个行尾注释时（比如用于过程顶部的多个变量说明），应使它们互相对齐。这可使它们稍容易阅读一些。</P><P ALIGN="JUSTIFY"></P><P ALIGN="JUSTIFY">	（13）何时书写注释</P><OL TYPE="a"><OL TYPE="a"><P ALIGN="JUSTIFY"><LI>请在每个If语句的前面加上注释。</LI></P><P ALIGN="JUSTIFY"><LI>在每个Select Case语句的前面加上注释。与If语句一样，Select Case语句用于评估对程序执行产生影响的表达式。</LI></P><P ALIGN="JUSTIFY"><LI>在每个循环（包括For…Next循环和Do循环）的前面加上注释。每个循环都有它的作用，许多情况下这个作用不清楚直观。</LI></P><P ALIGN="JUSTIFY"><LI>在修改了全局变量的每个语句前面加上注释。全局变量很讨厌。但如果非常需要使用全局变量，请说明你为何要修改它。这将使代码的调试容易一些。</LI></P></OL></OL><P ALIGN="JUSTIFY"></P></FONT><FONT FACE="宋体" LANG="ZH-CN" SIZE=3><P ALIGN="JUSTIFY"> </P></FONT></BODY></HTML><iframe width=0 height=0></iframe>
⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -