评论标准C.
发布时间：2020-12-16 10:21:49 所属栏目：百科 来源：网络整理
导读：我和乔治亚理工学院的一个名为Solar Jackets的团队合作,我们一直在进行“评论危机”.我们有许多成员毕业,并留下无评论的代码.我正在寻求实施评论标准,所以这不会发生,我需要一些建议,以确保我的所有基础都涵盖. 我想要的是以下功能： 一个合并的地方,您可以
|
我和乔治亚理工学院的一个名为Solar Jackets的团队合作,我们一直在进行“评论危机”.我们有许多成员毕业,并留下无评论的代码.我正在寻求实施评论标准,所以这不会发生,我需要一些建议,以确保我的所有基础都涵盖.
我想要的是以下功能： >一个合并的地方,您可以在其中查看每个功能描述, 我有什么可能遗漏的建议吗？是否有任何程序可以自动生成代码编译？我怎么能让程序员更容易？ 解决方法
你描述的东西让我想起了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;
}
（编辑：李大同） 【声明】本站内容均来自网络，其相关言论仅代表作者个人观点，不代表本站立场。若无意侵犯到您的权利，请及时与联系站长删除相关内容! |