评论标准C.

Question

我和乔治亚理工学院的一个名为Solar Jackets的团队合作,我们一直在进行"评论危机".我们有许多成员毕业,并留下无评论的代码.我正在寻求实施评论标准,所以这不会发生,我需要一些建议,以确保我的所有基础都涵盖.

我想要的是以下功能:

• 一个合并的位置,您可以在其中查看每个函数描述,包括包含,参数,返回类型和代码的一般描述.(根据代码中的注释生成)

• 在代码本身中,逐行(或接近)描述.

我有什么可能遗漏的建议吗？是否有任何程序可以自动生成代码编译？我怎么能让程序员更容易？

Answer 1

你描述的东西让我想起了Doxygen.它有一种格式用于注释代码中的所有实体,包括函数,参数,变量......通过检查Doxygen生成的警告,可以使用它来强制执行所有操作.它以不同的格式生成源代码的完整文档,如HTML,Latex,PDF,......

许多IDE都知道Doxygen标签,可以与Doxygen集成,以帮助开发人员评论代码.

这是Doxygen评论的一个例子:

/**
 * @brief This function does blah blah.
 * @param test blah blah parameter.
 * @return 0 if blah blah passed.
 */
uint32_t TestFunction( uint32_t test )
{
    return 0;
}