代码注释的好处

程序员对代码注释可以说是又爱又恨又双标……程序员不写注释这一事件呢,其实也没啥好说的,但无论如何,写注释就是比不写注释要好,请看下文:

一、代码应当注释

struct a{
    int n,m;
    bool flag;
    string nn;
};

相信大部分人看见上面的代码,早蒙圈了:n是啥,m是啥,nn又是啥,真是费解,但写成这样或许会好些:

struct a{ //学生账户
    int n,m; //年级,班级
    bool flag; //账户是否被注销
    string nn; //账户名
}

从这里就可以看出加注释的好处了。

二、程序员不写注释的原因

一般程序员不写注释是因为手懒或没时间,当然练习一般是没有人会去写注释的。但这里有一个问题:要是我写了很长的代码,然后错了,我去找错时就会很麻烦,因为我要结合题目来找一些变量的含义,所以我会浪费更多的时间,还不如写注释。所以本人的建议是去写注释,这样更清晰。

三、如何才能写出漂亮的注释

/*******************************************
 *******************************************
 ********* 这是一条警告程序员的消息 **********
 *******************************************
 *******************************************/

//--------------->另一种警告<----------------

//>>>>>>>>>>>>>>>主要内容标题<<<<<<<<<<<<<<<<

/*******************************************
 *用于程序开头的说明(一般)                 *
 *******************************************/

/*******************************************\
 *另一种画框法(不建议使用)                  *
\*******************************************/

/*
 *这样也能写注释
 *^^    ^   ^^
 *
/

//注释本行

评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值