代码文档。 [英] Code documentation.
问题描述
你好。
对于Java来说，有一个javadac，用于Obj-C headerdoc2html，用于C doxygen，甚至
用于好的旧VB 6还有VBDox。
但是我找不到合适的工具来记录我的.net代码以获得与MSDN提供的内容一致的文件和.net-develoepers
习惯了。
我想我只搜错了他错误的地方，或者用错误的关键字
:) 。
任何昙花一现。
问候
// Fredrik Olsson
Hello.
For Java there is javadac, for Obj-C headerdoc2html, for C doxygen, and even
for good old VB 6 there is VBDox.
But I have found no suitable tool for documenting my .net code to get
documentation that is consistent with what MSDN offers and .net-develoepers
are used to.
I guess I have only searched int he wrong places, or with the wrong keywords
:).
Any halpt is apreciated.
regards
//Fredrik Olsson
推荐答案
Fredrik Olsson写道：
Fredrik Olsson wrote:
Hello。
对于Java，有用于C的Obj-C headerdoc2h的javadac doxygen，
甚至对于老的VB 6都有VBDox。
但我发现没有合适的工具来记录我的.net代码以获得与什么一致的文档MSDN提供和
.net-develoepers习惯。
我猜测我只搜错了错误的地方，或者错误的关键字：）。
Hello.
For Java there is javadac, for Obj-C headerdoc2html, for C doxygen,
and even for good old VB 6 there is VBDox.
But I have found no suitable tool for documenting my .net code to get
documentation that is consistent with what MSDN offers and
.net-develoepers are used to.
I guess I have only searched int he wrong places, or with the wrong
keywords :).
使用C＃和VB.NET，你可以使用特殊格式评论（参见
http://msdn.microsoft.com/library/de...onComments.asp
例如）。 / doc编译器选项将导致编译器向包含文档的XML文件吐出
。然后，您可以使用各种工具来生成您喜欢的任何格式的帮助。 NDoc
（ http://ndoc.sourceforge.net/）非常好例如。
Arnaud
MVP - VC
With C# and VB.NET, you can use specially formatted comments (see
http://msdn.microsoft.com/library/de...onComments.asp
for example). The /doc compiler option will cause the compiler to spit out
an XML file containing the documentation. You can then use various tools to
generate the help in whatever format you like. NDoc
(http://ndoc.sourceforge.net/) is very good for example.
Arnaud
MVP - VC
" Arnaud Debaene"写道：
"Arnaud Debaene" wrote:
Fredrik Olsson写道：
Fredrik Olsson wrote:
你好。
对于Java，有一个javadac，用于Obj-C headerdoc2html，用于C doxygen，
但是我找不到合适的工具来记录我的.net代码以获得与MSDN提供的内容一致的文档和< br。> .net-develoepers已经习惯了。
我想我只是在他错误的地方搜索过，或者用错误的
关键字:)。
Hello.
For Java there is javadac, for Obj-C headerdoc2html, for C doxygen,
and even for good old VB 6 there is VBDox.
But I have found no suitable tool for documenting my .net code to get
documentation that is consistent with what MSDN offers and
.net-develoepers are used to.
I guess I have only searched int he wrong places, or with the wrong
keywords :).
使用C＃和VB.NET，您可以使用特殊格式的注释（参见
http://msdn.microsoft.com/library/de...onComments.asp
for例）。 / doc编译器选项将导致编译器吐出包含文档的XML文件。然后，您可以使用各种工具以您喜欢的任何格式生成帮助。 NDoc
（ http://ndoc.sourceforge.net/ ）非常好的例如。
我不寒而栗！
Javadoc，doxygen VBDox，headerdoc2html以及我看过的所有其他作品
非常类似于硬批量移植文档可以很容易地通过搜索和替换来实现
，如果你想要它可以用正则表达式完成
99％完美。
但这与不同不同。 cluncier，更难阅读和
维持。它并不像其他代码文档工具那样存在。
中间的xml格式是好的，我喜欢它。但是要让用户创建xml代码是非常可怕的，文档编译器应该这样做！
那个！
我会到处看看是否可以生成xml文件和/或$ C $ b与C＃编译器生成的wath兼容。如果没有，那么......我只会
必须增加项目时间...
感谢您的帮助，即使我不喜欢这个答案:)。
问候
/// Fredrik Olsson。
I shudder!
Javadoc, doxygen VBDox, headerdoc2html and all others I have looked at works
very similar so doing to hard bulk "porting" of documentation can quite
easily be made with a search and replace, do it with regexp if you want it
99% perfect.
But this is apart from being "different" cluncier, harder to read and
maintain. It is not as if other code documentation tools has net been around.
Having an intermediate xml-format is good, I like it. But making it up to the
user to create the xml-code is horrible, the documentation compiler should do
that!
I''ll go around and see if doxygen can be made into generating xml-documents
compatible with wath the C# compiler makes. And if not, well... I''ll just
have to add to the project time...
Thanks for the help, even if I did not like the answer :).
regards
/// Fredrik Olsson.
2005年7月15日星期五03:47:01 -0700，弗雷德里克奥尔森写道：
On Fri, 15 Jul 2005 03:47:01 -0700, Fredrik Olsson wrote:
但这与不同不同。 cluncier，更难阅读和维护。它并不像其他代码文档工具那样。
有一个中间的xml格式是好的，我喜欢它。但是要让
用户创建xml代码是非常糟糕的，文档编译器应该这样做！
But this is apart from being "different" cluncier, harder to read and
maintain. It is not as if other code documentation tools has net been around.
Having an intermediate xml-format is good, I like it. But making it up to the
user to create the xml-code is horrible, the documentation compiler should do
that!
我认为你在这里忽略了一些东西。在当前版本的
Visual Studio（2003）中，实际上没有自动注释格式化
for Visual Basic（这将出现在VS 2005中）。但是，在C＃中，只需将
放在任何方法或成员变量上方并键入3斜杠
（///）。 XML评论将自动为您生成。
您只需填写空白即可。如果你想添加额外的信息，比如
作为备注或抛出异常的描述，只需输入<并且将弹出
intellisense，为您提供所有可能的XML评论标签，您可以使用这些标签。选择一个，开始和结束标签将自动生成
。一旦你完成了你的XML文档，启动NDoc，点击一个
按钮，等待几秒钟（或一个大项目的几分钟），那就是你的
文档以你想要的任何格式完成：html页面，HTML帮助文件，
msdn样式，javadoc样式......从未使用过其他的doumentation
实用程序，i无法比较，但VS + NDoc让我很高兴这个
问题。
I think that you have overlooked something here. In the current version of
Visual Studio (2003), there is effectively no automatic comment formatting
for Visual Basic (this will appear in VS 2005). However, in C#, simply
place the cursor above any method or member variable and type 3 slashes
(///). The XML comment are going to be automatically generated for you.
You''ll just have to fill the blanks. And if you want to add extra info such
as remarks or description of exceptions thrown, simply type < and
intellisense will pop up to give you all the possible XML comment tags you
can use; choose one and the opening and closing tags will be automatically
generated. Once you''ve got your XML doc done, launch NDoc, click on a
button, wait a few seconds (or minutes for a big project) and that''s your
documentation done in whatever format you want: html pages, HTML help file,
msdn style, javadoc style... Having never used another doumentation
utility, i can''t compare, but the VS + NDoc makes me quite happy for this
matter.
这篇关于代码文档。的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！
