代码风格--注释和命名

一. doxygen

Doxygen 是一个程序的文件产生工具,可将程序中的特定批注转换成为说明文件。提供了一套注释方式便于把代码中的注释生成说明文档。

Doxygen简明注释语法

基于 Doxygen 的 C 语言简要注释规范

基于Doxygen的C/C++注释原则

Ubuntu 下使用 Doxygen_红超的吾记之谈_新浪博客

按照上述文档说明编码,然后生成doxygen注释文档:

doxygen -s -g  //生成配置文件Doxyfile

doxygen Doxyfile

生成的文档在html/index.html

二. google风格

Google 开源项目风格指南 (中文版)

 

posted @ 2016-06-23 17:53  yuxi_o  阅读(362)  评论(0编辑  收藏  举报