asp.net中的cs文件怎么生成注释xml

2008-05-14 06:07:31 528 阅读 AI 写同款 · GEO 优化AI 选题数据监测一键分发 ›

Swagger接口注释不显示？5分钟搞定XML配置与Program.cs调试本文详细解决了Swagger接口注释不显示的问题，通过XML配置与Program.cs调试步骤，帮助开发者快速恢复API文档的注释显示。文章涵盖了XML文档生成检查、Swagger配置读取注释文件的方法，以及多项目解决方案和调试技巧，确保Swagger文档完整显示接口描述。阅读详情

如题，如果项目为应用程序，属性页面中有一个生成注释文件的功能
但是网站就没有，以前用csc /doc:xx.xml
很不方便，怎么办呢？

...全文

EPLAN电气设计精华 -模拟量传感器画法全解本文介绍了EPLAN中模拟量压力传感器的标准画法要点，重点解析了电流型（4-20mA）、电压型（0-10V/0-5V）和特定应用型三种传感器的核心特点、典型符号、接线方式及应用场景。文章提供了EPLAN设备标识符示例，并分享了一个实际项目案例（XJC-Y01-20-4M传感器配合XJC-608T-F变送器和GSEE.GXLK-AI4S-I模块的应用），强调绘制前查阅技术资料的重要性。内容简明实用，有助于规范电气设计中的传感器绘制。阅读详情

萤火架构

.NET社区 62,272 成员 668,968 内容

+ 关注 + 加入社区

切换为时间正序

sunshinebailin 2008-06-23

打赏
举报

问题不是很明确，我知道的cs脚本代码注释有三种形式：//单行注释；/*多行注释*/；///xml注释。

anheizhizi 2008-05-15

打赏
举报

最简单的，直接打 /// 就可以

萤火架构 2008-05-15

打赏
举报

如果项目为应用程序，属性页面中有一个生成xml注释文件的功能

网站没有啊我用的VS2005

周公 2008-05-14

打赏
举报

把 Visual Studio .NET 源代码文件中C# XML注释提取成工程文档
摘要
C# 允许开发人员在源代码中插入XML注释，这在多人协作开发的时候显得特别有用。 C#解析器可以把代码文件中的这些XML标记提取出来，并作进一步的处理为外部文档。这篇文章将展示如何使用这些XML注释。作者演示了如何生成工程，如何把XML注释输出为有用文档，如何把这些注释转变为帮助文件。在项目开发中，很多人并不乐意写繁杂的文档。但是，开发组长希望代码注释尽可能详细；项目规划人员希望代码设计文档尽可能详尽；测试、检查人员希望功能说明书尽可能详细等等。如果这些文档都被要求写的话，保持它们同步比进行一个战役还痛苦。
为何不把这些信息保存在一个地方呢？？最明显想到的地方就是代码的注释中；但是你很难通览程序，并且有些需要这些文档的人并不懂编码。
这篇文章将展示如何通过使用XML注释来解决这些问题。代码注释、用户手册、开发人员手册、测试计划等很多文档可以很方便的从XML注释中获得。我将先演示如何插入XML注释、如何把这些XML注释导出为另一个文档。然后再讨论每个XML标记的意思，以及使用XML和XSL生成帮助文件。

XML 注释
所有的XML注释都在三个向前的斜线之后(///)。两条斜线表示是一个注释，编译器将忽略后面的内容。三条斜线告诉编译器，后面是XML注释，需要适当地处理。
当开发人员输入三个向前的斜线后，Microsoft Visual Studio .NET IDE 自动检查它是否在类或者类成员的定义的前面。如果是的话，Visual Studio .NET IDE 将自动插入注释标记，开发人员只需要增加些额外的标记和值。下面就是在成员函数前增加三个斜线，自动增加的注释：

/// <summary>
///
/// </summary>
/// <param name="strFilePath"></param>
public void LoadXMLFromFile(string strFilePath)

这里嵌入的标记仅仅是Visual Studio .NET IDE 的一部分标记，然而在IntelliSense for xml中，并没有把c#规范中所有的标记列出来，遗失的部分只能用手工插入。
这些手工标记是非常有用的，如果恰当地设置他们，对导出成外部说明文件将非常有帮助。
如果碰到是预先定义的xml标记，编译器可以把这些注释以文本输出；如果是编译器不认识的xml标记，编译器会逐字的把所有内容都输出，这意味着你可以使用自己定义的标记。
适当的设置，C#编译器并不格式化xml注释，而是以xml文件输出。下面的步骤将演示如何让C#编译器把xml注释输出为xml文件

右键点击解决方案资源管理器中的工程项，打开工程的属性页，点击属性。
对话框出现后，点击配置属性目录。
点击生成节点。
在右边的框中有输出--xml文档文件，这里就是设置丛xml注释生成xml文件的文件名。（注：这里设置的是相对路径，不是绝对路径）
在我的例子中，我使用GiveHelpDoc.xml作为文档名(看图一)。如果这里没有输入任何值，这将是默认设置，xml注释将不会以外部文件形式输出。
见：http://dev.csdn.net/article/19/19051.shtm

叶子 2008-05-14

打赏
举报

http://hi.baidu.com/czlaner/blog/item/aa9251d35e7005033af3cfce.html

叶子 2008-05-14

打赏
举报

C#中的XML注释
　　上篇文章提到过如何使用Sandcastle创建C#的帮助文档，这需要在源文件中插入XML注释，以“///”的形式出现。C#的“///<></>”注释在编译生成xml时候被抽取出来，是用Sandcastle自动生成CHM帮助文档必不可少的来源。

===========================================================
目录
一、常见标记
　　<summary>
　　<remarks>
　　<para>
　　<param>
　　<paramref>
　　<returns>
　　<see>
　　<seealso>
　　<example>
　　<c>
　　<code>
　　<value>
二、示例源代码
三、其它标记：
　　<typeparam>
　　<typeparamref>
　　<list>
　　<item>
　　<term>与<description>
　　<exception>
　　<include>

asp.net中的cs文件怎么生成注释xml

相关推荐