目录
不同语言的注释方式
IDE中的注释快捷键
注释是编程过程中非常重要的部分,被注释的文本不会被编译,因此注释非常适合用于在代码文档中解释代码。没有注释的代码无疑是维护者的灾难。众所周知,如果你恨一个程序员,就让他去研究别人编写的无注释程序。
注释有两个作用,最重要的作用是解释自己的代码和编程思路,让被人记恨的程序员能够比较容易的看懂。另一个作用是用作代码版本控制,有时候,如果一段代码你不确定是不是要删掉,可以先注释掉。等开发周期结束了再把确认无用的代码删掉。如果直接删掉,程序出了问题不好回退。
注释分为单行注释、多行注释(又称块注释)以及文档注释。单行注释只能将注释掉单行文本;多行注释可以同时对多行文本生效;文本注释主要是用来生成导出帮助文档(java中)。
在不同的编程语言中,注释方式不尽相同。这里做一个区分与总结:
不同语言的注释方式
1、C/C++/C#
单行注释://注释内容
多行注释:/* 注释
内容 */
2、Java
单行注释://注释内容
多行注释:/* 注释
内容 */
文档注释:/** 注释
内容 */
3、Matlab
单行注释:%注释内容
多行注释:%{
注释
内容
%}
注意:matlab的跨行注释中,注释符号必须单独占据一行,注释内容不能与注释符号同行。
4、Python
单行注释:#注释内容
多行注释:'''
注释
内容
'''
注意:同样的在Python跨行注释中,注释符号必须单独占据一行,注释内容不能与注释符号同行。
IDE中的注释快捷键
1、vs
注释:先按下 Ctrl+k ,再按下 Ctrl+c
取消注释:先按下 Ctrl+k, 再按下 Ctrl+u
2、eclipse
注释:Ctrl+/
取消注释:Ctrl+/
3、matlab
注释:Ctrl+r
取消注释:Ctrl+t