如果让自己的代码更好的让其他人理解

最近接手一个较大项目的代码,在阅读代码的过程中,发现下面可以利于自己的代码被其他人的tips,或许都是简单的规则,但是却发现十分的重要。

1)凡是数据结构中声明的变量都要有注释标识它的作用;

2)凡是全局变量的声明都需要注释;

3)凡是函数的声明处都需要添加注释;

4)全局变量的命名要一望便知,这个变量名不能是一个很通用的名词,可以考虑使用g_前缀。

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值