
以注释内容开始。
关于程序中注释书写格式
1程序文件注释:
放在程序名称空间引用(using SystemIO;)的上面,主要写公司的版权、文件创建的时间、文件的主要内容、文件的名字、文件的创建标识(创建人姓名)、文件修改的时间、文件修改时的修改标识(修改人姓名)、文件修改的修改原因等(详情见文档后备注示例);
2类的作用注释:
放在类(类、接口、枚举、结构体)的声明上方,主要描述类的作用。
如果类的结构比较复杂,也应该添加类的使用示例和类的流程(其它特点)
3、类的私有全局重要变量注释:
放在类的全局变量声明上方,主要需要注释通过命名不能正确理解的全局私有或公有(包含受保护等)变量。如果是object(特殊数组等)型变量,内部使用时结构比较复杂或有规定,需要简要的说明一下内部结构。
4、类的属性的注释:
放在类的属性声明上方,简要说明属性的类型和主要作用。
5、类的公有方法的注释:
主要说明方法的作用,方法各参数的意义和要求,方法的返回值及各种可能的返回值的特殊意义,方法可能会产生的异常,如果需要,则可以写出方法的使用示例;
6、类的私有方法或重要算法的注释:
除了需要说明公有方法所要求的之外,如果算法、数学运算比较复杂,需要写出算法或数学方法的理论过程或推导过程;如果算法比较长,要尽可能的细分成逻辑块,并填写适当的注释;对于方法中的重要变量也要添加适当的注释,特别是对方法的结果或方法某一段的结果的方法内部不易理解的变量要添加合适的注释;对于特别复杂(重要)的方法,要添加适当的流程图或文档,给以充分的文字、图解等说明;
7、文件、类或类的方法修改后的注释的变更:
对于对文件或类(包括接口、枚举、结构体)或类的方法修改后,要添加修改后的相注释,要写清修改的时间、修改标识(修改人姓名)、修改的原因等一切必要的信息和一切必要变更的信息(类、方法的流程);
试想一下,一个没有一句注释的程序源码,怎么读,一个程序要上万条代码不可能全部记得住哪一块是什么用,而且一个项目也不会是一个人独自完成,那样效率太低,多人合作就要给别人说明,每一块是什么用,方便他人使用,方便自己更正,而这些说明文字就是注释,注释不会被执行,不影响运行结果。
Java中代码的注释有三种:
// 注释一行
/ / 注释若干行
/ / 注释若干行,并写入 javadoc 文档
前两种比较容易理解,至于第三种,你学习Java看的api文档就是javadoc程序根据第三种的注释生成的。
扩展资料注释就是对代码的解释和说明,其目的是让人们能够更加轻松地了解代码。注释是编写程序时,写程序的人给一个语句、程序段、函数等的解释或提示,能提高程序代码的可读性。
汇编语言的注释是每行从分号“;”开始的,分号之后的内容都属于注释。一般而言,汇编语言的注释在以下几个地方:
1、程序的最前面,注释内容一般说明该程序总的说明,解释程序的主要功能,程序的版本号,程序的修改日志,程序的编制人等等
2、子程序的前面,一般说明该子程序或函数完成的功能,输入参数,输出参数,影响的标志位等等。
3、指令行的后面,注释该行语句的功能。
比如以下简单程序的注释。
;--------------------------------------
;该程序完成一个LED灯的闪烁
;编制时间:XXXXX
;完成人:XXXX
;--------------------------------------
ORG 0000H
LJMP MAIN:
ORG 0030H
MAIN:
CLR P10 ;led置低
LCALL DELAY ;延时
SETB P10 ;LED置高
LCALL DELAY ;延时
SJMP MAIN ;转MAIN循环
;------------------------------
;延时子程序
;输入参数:无
;输入参数:无
;------------------------------
DELAY:
MOV R2,#200
D1:
MOV R3,#250
DJNZ R3,$
DJNZ R2,D1
RET
END
a 加在模块首部的注释;
b.加在各分枝点处的注释;
c 对各变量的功能、范围、缺省条件等所加的注释;
d.对使用的逻辑所加的注释等等。
F.311限制条件
说明本程序运行中所受到的限制条件。
F.3.12测试计划
说明对本程序进行单体测试的计划,包括对测试的技术要求、输入数据、预期结果、进度安排、人员职责、设备条件驱动程序及桩模块等的规定。
F.313尚未解决的问题
说明在本程序的设计中尚未解决而设计者认为在软件完成之前应解决的问题。
F.4程序2(标识符)设计说明
用类似F.3的方式,说明第2个程序乃至第N个程序的设计考虑。
以上就是关于c语言中可以对程序进行注释,注释部分如果占多行,必须以__开始全部的内容,包括:c语言中可以对程序进行注释,注释部分如果占多行,必须以__开始、什么是注释如何在Java程序中加入注释、汇编语言如何注释等相关内容解答,如果想了解更多相关内容,可以关注我们,你们的支持是我们更新的动力!
欢迎分享,转载请注明来源:内存溢出
微信扫一扫
支付宝扫一扫
评论列表(0条)