搜索 问答 Rules & Tips
1. 遵守中国大陆相关法律法规
2. 在虫部落的提问准则
3. 禁止发布代下载类求助信息
4. 特别提倡抛砖引玉的问题
5. 扩展阅读:提问的智慧

函数注释应该放到头文件还是C文件?大家可以来讨论下

查看: 2577|回复: 0
Jelin 发表于 2021-10-8 11:07:40
我个人比较喜欢 Doxygen 的代码注释风格,我在Github上浏览一些C项目时发现很多项目都用 Doxygen 注释格式,目前许多代码编辑器或者IDE都支持 Doxygen 的代码注释识别,例如VSCode, CLion...

在注释的规范上我也思考了许多,最让我纠结的就是"函数注释应该放在头文件里还是C文件里"这个问题,我做了如下思考:
        - 如果放在C文件,好处是头文件就比较精简,在函数声明前加一行简单的函数说明,也未尝不可。
        - 如果放在头文件,好处是可以专注写函数的实现,而头文件就可以更加丰富,毕竟头文件是查看功能模块的第一入口。
        - 两者兼得,也可以,在C文件先写下注释,之后再同步一份到头文件,就是比较麻烦,增加一些维护成本

网上有相关的讨论,我觉得比较好的有这种:
        - 头文件写函数的相关信息,例如简介,参数说明,用法等,在函数体(C文件中)写该函数的实现原理,过程,维护信息等

这就又引出来几个问题:
        - 是否每个的函数都需要有注释?
        - 函数注释应该是”先写“还是”之后再写“?
        - 除了 Doxygen 还有没有别的好的代码注释风格?
        - 函数注释有必要吗?
        - 注释的简洁应该如何定义?

你有没有更好的Idea? 欢迎来这里讨论。

(PS: 上面是以C语言的代码注释进行讨论,其他类C风格的编程语言亦可讨论)
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

虫部落 陕ICP备14001577号-1川公网安备 51019002003015号联系我们FAQ关于虫部落免责声明虫部落生存法则蛙先知 - AI 玩家社区 🚧

Build with for "make search easier" Copyright © 2013-2024. Powered by Discuz! GMT+8, 2024-5-22 01:29

快速回复 返回顶部 返回列表