程序设计语言和编码.pptVIP

程序中的注解用来帮助人们理解程序，决不是可有可无的注解分为序言性注解和功能性注解一些正规的程序文本中，注解行的数量约占整个源程序的1／3到1／2，甚至更多程序的注释模块的功能重要的局部变量：包括用途、约束和限制条件模块的接口：包括调用格式、参数的解释、该模块需要调用的其它子模块名开发历史：包括模块的设计者、评审者、评审日期、修改日期以及对修改的描述通常置于每个程序模块的开头部分，主要描述：序言性注释序言性注释#includecompute.hintMouseLeftFlag=0;/*鼠标左键单击标志，全局变量1-单击0-未单击*//***********************************************************函数原型：voidinitmouse() **传入参数：无 **返回值：无 **函数功能：鼠标初始化 **鼠标初始化失败，则程序终止退出 ***********************************************************/voidinitmouse(){ unionREGSireg,oreg; intret; =0;/*鼠标器0号功能：鼠标复位*/ int86(0x33,ireg,oreg);/*调用0x33中断*/ ret=; if(ret!=-1)/*中断返回不是-1，表示未找到鼠标驱动*/ { printf(Mouseisnotinstalled.); exit(1); }}功能性注释通常嵌在源程序体内，主要描述程序段的功能。书写功能性注解时应注意的问题：注解要正确，错误的注解比没有注解更坏；为程序段作注解，而不是为每一个语句作注解；用缩进和空行，使程序与注释容易区分；注解应提供一些从程序本身难以得到的信息，而不是语句的重复。功能性注释#includecompute.hintMouseLeftFlag=0;/*鼠标左键单击标志，全局变量1-单击0-未单击*//***********************************************************函数原型：voidinitmouse() **传入参数：无 **返回值：无 **函数功能：鼠标初始化 **鼠标初始化失败，则程序终止退出 ***********************************************************/voidinitmouse(){ unionREGSireg,oreg; intret; =0;/*鼠标器0号功能：鼠标复位*/ int86(0x33,ireg,oreg);/*调用0x33中断*/ ret=; if(ret!=-1)/*中断返回不是-1，表示未找到鼠标驱动*/ { printf(Mouseisnotinstalled.); exit(1); }}例如，下面的模块级注释描述了公共的和私有的过程（在类模块中称为“方法”）、属性及其数据类型，以及如何将该类作为对象来使用的有关信息：公共方法：MailAddRecipient(strNameAsString,OptionalfTypeAsBoolean)