记录C代码 [英] Documenting C Code

问题描述

您对代码做了哪些文档？我从来没有在一个大项目上做过任何代码

开发，我想开始以某种方式记录我的代码

有意义，易于理解，信息丰富等等


你如何记录：

* .c文件头

* .h文件头

功能

变量？


杰夫


也许有点旧，但我想要一个C具体观点。另外，有没有类似于JavaDoc for C的工具

？

What sort of documentation do you do on your code? I''ve never done any code
development on a big project and I want to start documenting my code in a way
that makes sense, is easy to understand, informative, etc.

How would you document:
*.c file headers
*.h file headers
Functions
Variables?

Jeff

Maybe a little OT, but I want a C specific viewpoint. Also, are there tools
similar to JavaDoc for C?

推荐答案

2003年11月17日星期一20:34:52 -0700，Jeff Rodriguez

< ne ******** @ gurugeek.EXAMPLENOSPAM.com>在comp.lang.c中写道：

On Mon, 17 Nov 2003 20:34:52 -0700, Jeff Rodriguez
<ne********@gurugeek.EXAMPLENOSPAM.com> wrote in comp.lang.c:

你对你的代码做了什么样的文档？我从来没有在一个大项目上做过任何代码开发，我想开始以一种有意义，易于理解，信息丰富等方式记录我的代码。
<你怎么记录：
* .c文件头
* .h文件头
功能
变量？

杰夫

也许有点旧，但我想要一个C特定的观点。还有，类似于JavaDoc for C的工具吗？

What sort of documentation do you do on your code? I''ve never done any code
development on a big project and I want to start documenting my code in a way
that makes sense, is easy to understand, informative, etc.

How would you document:
*.c file headers
*.h file headers
Functions
Variables?

Jeff

Maybe a little OT, but I want a C specific viewpoint. Also, are there tools
similar to JavaDoc for C?

www.doxygen.org


-

杰克克莱恩

主页： http://JK-Technology.Com


$常见问题b $ b comp.lang.c http：// www .eskimo.com / ~scs / C-faq / top.html

comp.lang.c ++ http://www.parashift.com/c++-faq-lite/

alt.comp.lang.learn .c-c ++ ftp://snurse-l.org/pub/ acllc -c ++ / faq

www.doxygen.org

--
Jack Klein
Home: http://JK-Technology.Com
FAQs for
comp.lang.c http://www.eskimo.com/~scs/C-faq/top.html
comp.lang.c++ http://www.parashift.com/c++-faq-lite/
alt.comp.lang.learn.c-c++ ftp://snurse-l.org/pub/acllc-c++/faq

Jeff Rodriguez写道：

Jeff Rodriguez wrote:

你对你的代码做了什么样的文档？我从来没有在一个大项目上做任何代码开发，我想以一种有意义，易于理解，信息丰富等方式开始记录我的代码
<你怎么记录：
* .c文件头
* .h文件头
功能
变量？

杰夫

也许有点旧，但我想要一个C特定的观点。还有，类似于JavaDoc for C的工具吗？

What sort of documentation do you do on your code? I''ve never done any
code development on a big project and I want to start documenting my code
in a way that makes sense, is easy to understand, informative, etc.

How would you document:
*.c file headers
*.h file headers
Functions
Variables?

Jeff

Maybe a little OT, but I want a C specific viewpoint. Also, are there
tools similar to JavaDoc for C?

Doxygen是记录C代码的一个很好的起点，但它不是

be all和all all。你真正需要记录的不是

数据类型和函数本身（虽然这很重要，而且

Doxygen当然可以帮助你）但是关系

他们*以及如何使用这些关系*。这是关键;这很关键;

这是大多数文档失败的地方。

-

Richard Heathfield： bi **** @ eton.powernet.co.uk

Usenet是一个奇怪的地方。 - Dennis M Ritchie，1999年7月29日。

C FAQ： http://www.eskimo.com/~scs/C-faq/top.html

K& R答案，C书等：< a rel =nofollowhref =http://users.powernet.co.uk/etontarget =_ blank> http://users.powernet.co.uk/eton

Doxygen makes a great starting point for documenting C code, but it''s not
the be all and end all. What you really need to document is not so much the
data types and functions themselves (although that is important, and
Doxygen can certainly help you with that) but the relationships between
them *and how to use those relationships*. This is key; this is critical;
and this is where most documentation fails.
--
Richard Heathfield : bi****@eton.powernet.co.uk
"Usenet is a strange place." - Dennis M Ritchie, 29 July 1999.
C FAQ: http://www.eskimo.com/~scs/C-faq/top.html
K&R answers, C books, etc: http://users.powernet.co.uk/eton

在文章< Zqgub.19692

In article <Zqgub.19692

这篇关于记录C代码的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！