ASP.NET网站中的XML文档 [英] XML Documentation in ASP.NET web sites
问题描述
由于我从未见过以下问题的答案，我将重新发布：
嗨
我使用ASP.NET 2代码隐藏文件和Visual Studio 2005团队中的C＃
版。
我嵌入了大量XML文档（< summary>，< see>，等）进入我的
ASP.NET项目，代码隐藏在ASP页面，用户控件和类的文件中，在App_Code目录中是
。我添加了/ doc编译器选项使用
web.config（参见帖子底部的片段）。
当我构建我的网站时，它似乎只生成XML文档
只有一个文件。
有没有办法生成网络项目的所有文档？
如果我给的话/ doc选项的完整路径我可以找到输出但是如果
i只是给出一个文件名我不知道它在哪里创建文件。
有没有人Web项目的XML文档是否有任何成功？让
我
知道网上是否有遗失的工作。
谢谢
Ben Crinion
< system.codedom>
< compilers>
< compiler
language =" c＃; cs; csharp"
extension =" .cs"
type =" Microsoft.CSharp.CSharpCodeProvider"
compilerOptions =" / doc：c：\ XMLDOCS.xml"
warningLevel =" 1" />
< /编译器>
< /system.codedom
-
http://www.zbitinc.com
Since I never seen the following question answered, I am re-posting it:
Hi
Im using ASP.NET 2 with C# in codebehind files and Visual Studio 2005 Team
Edition.
I have embedded lots of XML Documentation (<summary>,<see>,etc) into my
ASP.NET project in code behind files of ASP pages, user controls and classes
in the App_Code directory. I have added the "/doc" compiler option using the
web.config (see snippet at bottom of post).
When i build my website it seems to only generate the XML documentation for
one file only.
Is there a way to generate all documentation for the web project?
Also if i give the full path to the /doc option i can find the output but if
i just give a file name i dont know where it creates the file.
Has anyone ever had any success with XML documentation of web projects? Let
me
know if there is a work around that im missing on the web.
Thanks
Ben Crinion
<system.codedom>
<compilers>
<compiler
language="c#;cs;csharp"
extension=".cs"
type="Microsoft.CSharp.CSharpCodeProvider"
compilerOptions="/doc:c:\XMLDOCS.xml"
warningLevel="1" />
</compilers>
</system.codedom
--
http://www.zbitinc.com
推荐答案
嗨Ben，
感谢发布！
对于当前的问题，我的理解是你想要的为当前的ASP.NET应用程序生成
XML文档。如果我误解了
任何东西，请随时告诉我。
根据我的经验，如果你想为
当前的Web应用程序，我建议您在当前的
阶段使用NDoc工具。添加编译选项不适用于大型和
正式Web项目。您可以通过访问以下链接获取有关NDoc工具的更多信息：
http://www.sitepoint.com/print/dot-n...mentation-ndoc
希望这会有所帮助！
问候，
元人
Microsoft在线社区支持
============================================ ======
在回复帖子时，请回复群组通过你的新闻阅读器
其他人可以从你的问题中学习并从中受益。
==================== ==============================
此帖子按原样提供。没有保证，也没有授予任何权利。
Hi Ben,
Thanks for posting!
For the current issue, my understanding is that you want to generate the
XML document for the current ASP.NET application. If I have misunderstood
anything, please feel free to let me know.
Based on my experience, if you want to generate all document for the
current web application, I recommend you use the NDoc tool at the current
stage. Adding the compile option is not appropriated for the large and
formal web project. You can obtain more information about the NDoc tool via
accessing the following link:
http://www.sitepoint.com/print/dot-n...mentation-ndoc
Hope this will be helpful!
Regards,
Yuan Ren
Microsoft Online Community Support
==================================================
When responding to posts, please "Reply to Group" via your newsreader so
that others may learn and benefit from your issue.
==================================================
This posting is provided "AS IS" with no warranties, and confers no rights.
亲爱的袁仁，
感谢您的回复。
然而，你在我的帖子中遗漏了一个小但非常关键的细节。我问的是关于ASP.NET 2.0（不是版本1.x）的
。我一直在以前的
版本的.NET中使用NDoc，并对此非常满意。现在，随着2.0
和Visual Studio 2005的发布，
记录Web项目（网站）有两个主要问题。
当然，一个是NDoc不支持.NET 2.0版本，如果你能提供一个Microsofta的内部产品，那么你的
输入将非常受欢迎
工具。但是在我们进入实际的文档制作流程之前，我们需要能够从我们的web
项目中实现.XML文档，这不是很很容易或者我不知道如何在新的
环境中做到这一点。
我期待着找出是否有解决方案/解决方法
解决这两个问题。
-
http://www.zbitinc.com
"" Yuan Ren [MSFT]""写道：
Dear Yuan Ren,
Thank you for your reply.
However, you missed a small but very crucial detail in my post. I am asking
about ASP.NET 2.0 (not version 1.x). I have been using NDoc in the previous
version of .NET and was very happy with that. Now, with the release of 2.0
and Visual Studio 2005, however, there are two major problems with
documenting Web Projects (Web Sites).
One, of course, is that NDoc does NOT support version 2.0 of .NET and your
input will be greatly appreciated if you could supply a Microsofta??s internal
tool for this. But even before we get to the actual Documentation production
process, we need to be able to materialize the .XML document out of our web
project, and that is not very easy or I dona??t know how to do it in the new
environment.
I am looking forward to find out if there are solutions/workarounds to
resolve both of those issues.
--
http://www.zbitinc.com
""Yuan Ren[MSFT]"" wrote:
嗨Ben，
感谢发帖！
对于当前的问题，我的理解是你要生成当前ASP.NET应用程序的XML文档。如果我误解了什么，请随时告诉我。
根据我的经验，如果您想为当前的Web应用程序生成所有文档，我建议你在当前的阶段使用NDoc工具。添加编译选项并不适用于大型和正式的Web项目。您可以通过访问以下链接获取有关NDoc工具的更多信息：
http://www.sitepoint.com/print/dot-n...mentation-ndoc
希望这会有所帮助！
问候，袁仁
微软在线社区支持
================== ================================
在回复帖子时，请回复群组通过您的新闻阅读器，以便其他人可以从您的问题中学习并从中受益。
============================ ======================
此帖子是原样提供的。没有保证，也没有授予任何权利。
Hi Ben,
Thanks for posting!
For the current issue, my understanding is that you want to generate the
XML document for the current ASP.NET application. If I have misunderstood
anything, please feel free to let me know.
Based on my experience, if you want to generate all document for the
current web application, I recommend you use the NDoc tool at the current
stage. Adding the compile option is not appropriated for the large and
formal web project. You can obtain more information about the NDoc tool via
accessing the following link:
http://www.sitepoint.com/print/dot-n...mentation-ndoc
Hope this will be helpful!
Regards,
Yuan Ren
Microsoft Online Community Support
==================================================
When responding to posts, please "Reply to Group" via your newsreader so
that others may learn and benefit from your issue.
==================================================
This posting is provided "AS IS" with no warranties, and confers no rights.
嗨Ben，
谢谢你的支持回复！
在目前阶段，据我所知，NDoc工具支持
NET 2.0。您可以通过访问以下链接获取更多详细信息：
http ：//community.rainbowportal.net/b...g/archive/2006
/ 03/21/1685.aspx
实际上，大多数开发人员使用NDoc工具为他们的.NET应用程序生成文档
。来自MSDN和其他第三方
站点的文章也演示了如何使用NDoc工具来解决这个问题：
为Visual Basic .NET应用程序生成文档：
http：/ /msdn.microsoft.com/library/de...us/dv_vstechar
t / html / vbgeneratingdocs.asp
"代码文档在.NET中：
http://aspalliance.com/696
我理解情景与当前问题不同。但是，正如你提到的那样，
编译后，ASP.NET只生成单个xml文件。如果要实现XML文档文件，NDoc
工具可以适用于当前问题。您还可以找到其他
工具来完成当前的工作，例如DocumentX，HelpStudio等
。但是，其中一些不是免费的。
希望这会有所帮助！
问候，
元人
微软在线社区支持
========================= =========================
在回复帖子时，请回复群组通过你的新闻阅读器
其他人可以从你的问题中学习并从中受益。
==================== ==============================
此帖子按原样提供。没有保证，也没有授予任何权利。
Hi Ben,
Thanks for your reply!
At the current stage, as far as I know, the NDoc tool has supported the
NET 2.0. You can obtain more details via accessing the following link:
http://community.rainbowportal.net/b...g/archive/2006
/03/21/1685.aspx
Actually, most developers use the NDoc tool to generate the documentation
for their .NET application. The article from MSDN and other third party
site also demonstrate how to use the NDoc tool to approach this:
"Generating Documentation for Your Visual Basic .NET Applications":
http://msdn.microsoft.com/library/de...us/dv_vstechar
t/html/vbgeneratingdocs.asp
"Code Documentation in .NET":
http://aspalliance.com/696
I understand the scenario is different from the current issue. However, as
you mentioned, the ASP.NET only generate the single xml file after
compilation. If you want to materialize the XML document file, the NDoc
tool is much appropriated for the current issue. You can also find other
tools to finish the current job such as the DocumentX, HelpStudio and so
on. However, some of these are not free.
Hope this will be helpful!
Regards,
Yuan Ren
Microsoft Online Community Support
==================================================
When responding to posts, please "Reply to Group" via your newsreader so
that others may learn and benefit from your issue.
==================================================
This posting is provided "AS IS" with no warranties, and confers no rights.
这篇关于ASP.NET网站中的XML文档的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！
