最近又学习了一门新语言,发现注释和以往有很大差别,在下面简单总结下注释和目前流行的几大高级语言如C、C++、C#、JAVA、python、MATLAB中的注释,献给初学者,欢迎补充>。<
关于高级语言中的注释:
1、注释是代码的“提示”或“解释”而非文档;注释主要用于解释代码复杂度;注释应准确、易懂(无二义性)、简洁;程序中有效注释量必须在20%以上。
说明:代码清楚可以自注释的不需加注释,过分详细的注释容易使人厌烦,切记不要自以为高深让别人看不懂而不加注释。
2、注释的目的:为了便于代码的维护、解释代码的功能和方法等方便读者阅读,以及防止不必要的重复信息。
3、给代码添加注释绝对是好习惯,最好边写代码边注释
C语言和C++中注释情况一样:
1、单行注释:
//这是单行注释
2、多行注释:以“/”表示注释开始,“/”表示注释结束。
/*
我是
多行
注释
*/
3、也可以进行组合,但不必要,格式尽量统一,最好都使用/…/
/*
//也是注释
*/
4、说明:函数头部应注释,简单扼要的列出函数的名称、功能、调用关系、返回值、输入、输出参数等;变量、常量、最好声明时进行注释;数组、类、枚举等等命名不是自注释的,必须注释。
JAVA:
1、有单行、多行和文档注释,其中,单、多行注释与c语言的相同。
2、文档注释:
/**
文档注释啦
*/
3、说明:由于在一些开发工具中,多行注释格式化后效果不好,所以开发项目时尽可能使用单行注释;另外,需要有开发工具支持才能更好地编写文档注释
快捷注释(很多IDE都适用):Ctrl+/
Python:
快捷注释:Ctrl+/(一般都适用,但IDLE好像不行)
和以往都不同,Python语言中单行注释以#开头
多行注释以”’开头,”’结尾(三个单引号)。
例如:
a,b=0,1
while a<1000: #这是单行注释:输出小于1000的元素
print(a,end=',')
a,b=b,a+b
'''
print('hello')
这是多行注释,不被编译器识别的
'''
MATLAB:
快捷注释:
点击ctrl+R,注释程序;可多次点击,多次注释同一次选中的代码;
点击ctrl+T,取消注释程序。
% 我是单行注释
%{
我是多行注释
啦啦啦
%}
if 0
我也可以多行注释
啦啦啦
end
叠加也可以