如何写出好的代码注释 |
您所在的位置：网站首页 › 洗涤用品分类与编码怎么写好看 › 如何写出好的代码注释 |
|
文章目录
一、引言1. 什么是代码注释？行内注释块注释文档注释特殊注释
2. 为什么要写代码注释？
二、注释的原则1. 简洁明了2. 写明意图3. 与代码保持一致
三、逻辑清晰、命名规范的代码胜于混乱和冗余的注释四、结论五、参考博文
一、引言
1. 什么是代码注释？
代码注释（以下简称注释）是嵌入在代码中的解释性文本，它们一般不会被编译或执行，但可以提供给开发者一些有用的信息。 不同编程语言的注释格式可能不同，本文使用C语言来介绍。 C语言有两种注释格式: // 这是一段注释 /* 这也是一段注释 */实际项目中的注释根据其形式和作用的不同，大体可以分为以下四类 行内注释 int a = 5; // 这是一个行内注释 // 这是一个行内注释 int a = 5; 块注释 /* * 这是一个块注释 * 块注释可以跨越多行 */ int b = 10; 文档注释 /** * @brief 这是一个计算一个数的平方的函数 * @param x 要平方的数 * @return 输入数的平方 */ int square(int x) { return x * x; }文档注释可以有多种格式，这个例子使用的是Doxygen文档注释格式，它可以将程序中的注释转换成说明文档或者API参考手册，减少手动整理文档的时间 Doxygen格式文档参考链接： 官方文档: Doxygen Document 中文介绍: 代码注释规范之Doxygen 特殊注释在开发过程中，我们常会用到某些特定的标记(如TODO、FIXME、NOTE等)，它们可以帮助开发者管理和记录代码中的任务、问题和重要信息，我们可以通过全局搜索TODO、FIXEME这样的标记来了解代码中还有哪些地方没有完善。 int processData() { // NOTE: 这是一个临时解决方案，之后会对其进行重构 // TODO: 增加异常处理功能 // FIXME: 优化循环性能 for (int i = 0; i |
今日新闻 |
推荐新闻 |
| CopyRight 2018-2019 办公设备维修网 版权所有 豫ICP备15022753号-3 |