编程 | C/C++代码规范注释

本文详细介绍了C/C++编程中的注释规范,包括文件注释、函数注释、变量注释和拼写注释的标准做法,强调了注释的一致性和功能描述的重要性。建议在编程实践中遵循这些规范,以提高代码可读性和团队协作效率。
摘要由CSDN通过智能技术生成

注释风格

1. 总述

一般使用//或/* */,只要统一就好。

2. 说明

//或/* */都可以,但团队要在如何注释及注释风格上确保统一。

文件注释

1. 总述

在每一个文件开头加入版权、作者、时间等描述。

文件注释描述了该文件的内容,如果一个文件只声明,或实现,或测试了一个对象,并且这个对象已经在它的声明处进行了详细的注释,那么就没必要再加上文件注释,除此之外的其他文件都需要文件注释。

2. 说明

法律公告和作者信息:

每个文件都应该包含许可证引用。也要为项目选择合适的许可证版本。

3. 文件内容

如果一个 .h 文件声明了多个概念, 则文件注释应当对文件的内容做一个大致的说明, 同时说明各概念之间的联系。

一个一到两行的文件注释就足够了, 对于每个概念的详细文档应当放在各个概念中, 而不是文件注释中。

不要在 .h 和 .cc 之间复制注释, 这样的注释偏离了注释的实际意义。

最后再举个最简单的实际例子:

/**************************************************************************    

Copyright  Copyright 2020 Google Inc.*    File Name: 文件名*    Descr

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

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值