代码注释怎么添加？

在代码中可以通过：//注释、/*注释*/、、#注释、'''注释'''、--注释、'注释、%注释等等方式来添加注释。下面本篇文章就来给大家分类介绍一下代码注释的方法，希望对大家有所帮助。

常见的代码注释方法：

HTML注释

<!--这里是注释-->

CSS注释

/*这里是注释*/

JavaScript注释

单行注释：

//这里是注释

块（多行）注释：

/*这里是注释*/

XML注释

<!--这里是注释-->

C/C++/C#代码注释

单行注释：

//这里是注释

块（多行）注释：

/*这里是注释*/

Java注释

单行注释：

//这里是注释

块（多行）注释：

/*这里是注释*/

Python注释

单行注释：

#这里是注释

块（多行）注释：

'''这里是注释'''

VB注释

'这是一个单行注释

注：是一个单引号后跟注释

perl注释

单行注释：

# 这是一个单行注释

块（多行）注释：

=pod 
这里是注释
=cut

Matlab注释

单行注释：

%这里是注释

块（多行）注释：

%%这里是注释%%
%{这里是注释%}

R语言注释

单行注释：

#这里是注释

块（多行）注释：

if(false){这里是注释}

为什么要添加注释？

注释是代码的“提示”或“解释”，而非文档；注释主要用于解释代码复杂度；注释应准确、易懂（无二义性）、简洁；程序中有效注释量必须在20％以上。 给代码添加注释绝对是好习惯，最好边写代码边注释

注释的目的：为了便于代码的维护、解释代码的功能和方法等方便读者阅读，以及防止不必要的重复信息。 

说明：代码清楚可以自注释的不需加注释，过分详细的注释容易使人厌烦，切记不要自以为高深让别人看不懂而不加注释。 

以上就是本篇文章的全部内容，希望能对大家的学习有所帮助。更多精彩内容大家可以关注php中文网相关教程栏目！！！

Atas ialah kandungan terperinci 代码注释怎么添加？. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!