1. 首页 > 科技

看代码加注释能高效工作吗?(怎么给代码加注释?)

看代码加注释能高效工作吗?(怎么给代码加注释?)

怎么给代码加注释?

C/C++/C#

行注释://这里是注释

块注释:/*这里是注释*/

Java

行注释://这里是注释

块注释:/*这里是注释*/

HTML

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

CSS

块注释:/*这里是注释*/

JavaScript

行注释://这里是注释

块注释:/*这里是注释*/

XML

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

Python

行注释:#这里是注释

块注释:'''这里是注释'''

SQL Server/Oracle PLSQL

行注释:--这里是注释

块注释:/*这里是注释*/

MySQL

行注释:--这里是注释

行注释:#这里是注释

块注释:/*这里是注释*/

VB

行注释:'这里是注释

汇编语言

行注释:;这里是注释

perl

行注释:# 这是一个单行注释

块注释:

=pod 

这里是注释

=cut

Matlab

行注释:%这里是注释

块注释:%%这里是注释%%

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

R语言

行注释:#这里是注释

块注释:if(false){这里是注释}

扩展资料:

关于高级语言中的注释:

1、注释是代码的“提示”或“解释”而非文档;注释主要用于解释代码复杂度;注释应准确、易懂(无二义性)、简洁;程序中有效注释量必须在20%以上。 

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

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

3、给代码添加注释绝对是好习惯,最好边写代码边注释

程序为什么要加注释?加注释有几种方法?各有何特点

注释为对代码的解释和说明,其目的是让人们能够更加轻松地了解代码。注释为编写程序时,写程序的人给一个语句、程序段、函数等的解释或提示,能提高程序代码的可读性。注释只是为了提高可读性,不会被计算机编译。

注释通常会分为行注释和块注释。

行注释:在符号后那一行不会被编译(显示);块注释:被块注释符号中间的部分不会被编译。

扩展资料

C语言的注释符以“/*”开头并以“*/”结尾的串。在“/*”和“*/”之间的即为注释。程序编译时,不对注释作任何处理。注释可出现在程序中的任何位置。

注释用来向用户提示或解释程序的意义。在调试程序中对暂不使用的语句也可用注释符括起来,使翻译跳过不作处理,待调试结束后再去掉注释符。

可以使用多种方法创建文字。对简短的输入项使用单行文字。对带有内部格式的较长的输入项使用多行文字(也称为多行文字)。也可创建带有引线的多行文字。

虽然所有输入的文字都使用建立了默认字体和格式设置的当前文字样式,但也可以使用其他的方法自定义文字外观。有一些工具可以方便用户修改文字比例和对正、查找和替换文字以及检查拼写错误。

参考资料来源:百度百科-注释符

参考资料来源:百度百科-注释

怎么才能看懂代码太长的程序!

程序是最老实的,你肯花时间肯定看的懂

通常情况下,我的方法是

同时了解全篇代码的流程注释上大块的功能,由于加了注释,就把长篇代码分成

了功能块,最后就是理解这些功能块了。。。可能注释的时候会有错,但是不要

紧,具体理解的时候可以再改正,最后就能分析出整个的原理了

2:不能运行的话

我一般先找出错误所在,将错误屏蔽,或者理解错误点的意思,然后跳过,继续

看下面的代码。如果能屏蔽后运行,就照1的做,可能牵扯太多,改起来很浪费

时间那就直接跳过,放弃自己的思路,直接理解作者的思路(个人觉得那样比较

累),然后跟着走,还是同1

以上说的重点,在于(1)理清功能实现思路,(2)浏览全篇代码,给自己一个流程印象

只要知道大概作用就好,方便后面自己详细分析

(4)分析理解每块功能代码,最后解析全篇

以上个人意见和方法,希望对你有些帮助,希望不会再被评差贴。。。

一个项目的代码注释和架构图重要吗

注释不重要,所有变量和方法注释,还有一些关键方法解释说明一下就够了

重要的是清晰的架构,文档 类图

你只要能让下一个拿到你代码的人看看文档就明白怎么回事就ok