如何在NET XML文档注释中设置XML代码
在NET XML文档注释中设置XML代码可以通过使用<code>标签来实现。<code>标签用于包裹需要显示为代码的内容，它可以提高可读性并使代码在文档中更加清晰。以下是设置XML代码的步骤：
- 打开你的NET项目，在需要添加XML注释的方法、属性或类的上方写入三个连续的斜杠(
///)，以生成XML注释块。 - 在XML注释块中，使用
<code>标签来包裹需要显示为代码的内容。例如，如果你要显示一个方法的代码片段，可以使用以下语法： - 在XML注释块中，使用
<code>标签来包裹需要显示为代码的内容。例如，如果你要显示一个方法的代码片段，可以使用以下语法： - 在
<code>标签内部，你可以使用各种XML标记来增强代码的展示效果。例如，你可以使用<see cref=""/>标记来引用其他代码元素，<paramref name=""/>标记来引用方法参数，或者使用<c></c>标记来突出显示某个特定的关键字。以下是一个例子： - 在
<code>标签内部，你可以使用各种XML标记来增强代码的展示效果。例如，你可以使用<see cref=""/>标记来引用其他代码元素，<paramref name=""/>标记来引用方法参数，或者使用<c></c>标记来突出显示某个特定的关键字。以下是一个例子：
以上就是在NET XML文档注释中设置XML代码的方法。请注意，这只是一种常见的做法，并且可以根据个人喜好和项目要求进行调整。对于NET开发者来说，XML注释是一种重要的实践，可以提高代码的可读性和可维护性。
相关·内容
3回答
如何在.NET中自动换行？
、、、、
我希望有一个命令来自动对.NET中的XML样式的注释进行换行。
示例：
/// <summary>
/// This comment line should be
/// on one line, and other lines in this <summary> block should be wordwrapped.
/// </summary>
我不介意购买一些商业Visual Studio插件，如果他们能够做到这一点的话。
浏览 0提问于2011-10-02得票数 6
回答已采纳
1回答
当我尝试编译FreeImageNET C#包装器时，我不断收到几条错误消息(当前为35条)。所有消息都采用相同的格式。
实际上我发现以前有人问过这个问题，答案是把"typeparamref“改成"paramref”。但是，其余的错误消息已经包含了"paramref“，所以我不知道如何修改才能纠正这些错误。
任何帮助都将不胜感激。
其中两条错误消息如下：
Error 1 Warning as Error: XML comment on 'FreeImageAPI.Palette.Palette(FreeImageAPI.Metadata.MetadataT
浏览 0提问于2012-08-14得票数 0
回答已采纳
1回答
调用中的堆栈线程
、、、、
我在Tomcat容器中有一个卡住的线程，我想找出避免这个问题的原因。
使用jstack，我发现它在SOAP调用之后被卡住了：
pool-2-thread-1" #27 prio=5 os_prio=0 tid=0x00007fd2315ce800 nid=0x39 runnable [0x00007fd2415d2000]
java.lang.Thread.State: RUNNABLE
at java.net.SocketInputStream.socketRead0(Native Method)
at java.net.SocketInputStream.so
浏览 9提问于2022-02-24得票数 4
回答已采纳
我正在用ASP.NET在C#中维护已经开发的Web应用程序。
在这里，我看到了以下XML注释代码块。我知道为什么在C#中使用这个XML注释。但是我不知道如何实现这个代码块！如果它是自动生成的，还是有其他的方法？
/// <summary>
/// This is a Login Attempt Class
/// </summary>
public void GetLoginAttempts(){}
请帮帮我..。
浏览 1提问于2017-11-22得票数 0
回答已采纳
1回答
在vb.net中，我可以使用一些标记编写XML文档，如下所示
'''<summary>
''' Hello there!
'''</summary>
在Java中，我只需一次单击就可以导出Javadoc文档(它生成一个Html文件)。
在vb.net中有类似的方法吗？
浏览 1提问于2020-09-05得票数 0
回答已采纳
我正在尝试使用Store Wrapper API ()下载一个XML文件。
当我使用WP8StoreApp时，当在Google Chrome中查看时，它显示为XML文件。但是，当我在Windows Phone上使用相同的方法时，它会返回一个JSON。
下面是我的代码片段：
WebClient twitter = new WebClient();
twitter.DownloadStringCompleted += new DownloadStringCompletedEventHandler
(twitter_DownloadStringCompleted);
twitter.Down
浏览 2提问于2014-08-04得票数 1
您是否注意到，对于系统程序集中的某些方法，.NET反射器也会显示相应的文档？这意味着文档可以持久化在程序集元数据中。
如何使其适用于我自己的程序集？这意味着，当我在.NET反射器中反射我的方法时，我希望看到我对它的注释。
谢谢。
浏览 0提问于2009-07-29得票数 4
回答已采纳
1回答
当询问C#代码中文档注释的约定时，答案总是会导致使用XML。微软自己也推荐这种方法。
/// <summary>
/// This is an XML comment.
/// </summary>
void Foo();
但是，当检查微软的代码(如ASP.NET核心)时，注释却如下所示。
//
// Summary:
// A builder for Microsoft.AspNetCore.Hosting.IWebHost.
public interface IWebHostBuilder
所包含的文档生成工具是否使用此约定，或者是否有使用此约定而不是XML
浏览 2提问于2019-02-02得票数 14
3回答
我正在为我的.NET Core web api项目使用Swashbuckle.AspNetCore包。我希望添加XML注释支持，因此我必须在应用程序设置中将Build => Output => XML documentation file设置为true。
不幸的是，自动生成的路径是绝对路径
C:\Users\myUser\...\repository\solution\project\project.xml
所以这只在我的机器上有效。有没有办法使用占位符？例如。
{{pathToProject}}\project.xml
所以它在本地调试和部署时都可以工作吗？
浏览 0提问于2020-12-14得票数 3
我正在尝试更新REST的API文档。
目前，我有一个C# Asp.net Web代码和Swashbuckle.AspNetCore。我正在使用Visual在C#中编辑和添加XML注释，以更新API文档。
我是否可以使用SwaggerHub或其他允许我使用Markdown的工具来完成这个任务呢？
我还没有在网上找到任何解决方案。
浏览 11提问于2022-03-08得票数 0
1回答
外部注释文件不工作
、、、、
通过使用标记，我试图将代码的注释放在单独的文件"docs.xml“中。但不起作用。我一直在尝试C#和VB.NET项目。
这是我的评论文件：
<?xml version="1.0" encoding="utf-8" ?>
<d>
<summary>Demo summary</summary>
</d>
我有一个ABC课程，只有一个属性演示。在这个属性之前，我写：
/// <include file="docs.xml" path="d/*" />
或者在
浏览 1提问于2013-12-01得票数 5
回答已采纳
我正在使用jQuery .get拉入并解析一个xml文件。它在我的测试环境中工作得很好，但当移动到生产服务器上时，它就不能工作了。我的代码中有没有什么问题会导致这种情况？
$(document).ready(function()
{
$.ajax({
type: "GET",
url: "RSS/NinjaTraderRSS.xml",
dataType: "xml",
success: parseXml
浏览 2提问于2010-12-02得票数 0
回答已采纳
2回答
我正在学习如何将值保存到我的vb.net wpf应用程序上的应用程序设置中。但它们是在代码中创建新设置的简单方法。不只是改变旧的，创造新的。我正在为我的雇主做一个笔记记录程序，他是一个每天都做大量笔记的IT人员。我得把笔记留个地方。也许xml文件不是一个好主意，只是让我知道。
谢谢
浏览 3提问于2015-04-22得票数 0
回答已采纳
3回答
我有我的.Net项目。现在，我想为这个项目创建我的项目文档。Visual 2013中是否有任何工具可以帮助我根据为不同类、函数等添加的注释构建文档？
浏览 1提问于2014-03-04得票数 1
回答已采纳
1回答
我注意到，在C#中，通过更改工具>选项>环境>字体和颜色>显示项中的设置，XML注释和代码注释可以有不同的颜色：-注释:控件代码注释- XML注释:控件XML注释
这在C#中运行良好
///<summary>This XML comment is green</summary>
//This code comment is red
但不是在VB.NET中
'''<summary>This XML comment appears red too even though it's configured a
浏览 0提问于2011-09-26得票数 7
回答已采纳
我正在使用Sandcastle Help File Builder为一个VB.net项目构建文档，但是asp.net/html元素的文档没有出现。
这些注释的xml注释在相应的Web Form或Web Forms用户控件的.ascx.designer.vb文件中定义。此代码的示例如下所示：
Partial Public Class WebUserControl
'''<summary>
'''TblsDiv control.
'''</summary>
浏览 7提问于2019-11-29得票数 0
6回答
我无法理解使用XML注释的优点。我知道它们可以转换成代码外部的优秀文档，但同样可以通过更加简洁的DOxygen语法来实现。我认为XML注释是错误的，因为：
他们混淆了注释和代码。(人类更难以阅读)。
可以在单个屏幕上查看更少的代码，因为“汇总”和"/summary“需要额外的行。
(移除)
那么，.NET为什么会比简单的DOxygen语法更受欢迎呢？
浏览 14提问于2010-04-06得票数 9
回答已采纳
我正在尝试将StAX与Spring WS 2.0.2一起使用，但我没有任何机会让它正常工作。我在网上找到了一个示例，但它使用的是AbstractStaxStreamPayloadEndpoint，在Spring WS2.x中已被弃用。我尝试使用@Endpoint注解方法，但得到以下错误：
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header/>
<SOAP-ENV:Body>
<
浏览 0提问于2011-06-09得票数 2
回答已采纳
2回答
我正在寻找更有效地帮助编辑和管理好的XML代码注释的工具，因为当我想要编写更详细的注释时，Visual中的编辑功能似乎不会扩展(包括项目列表、表和更长的解释)。更具体而言：
在代码中很好地格式化xml注释(包装、自动xml格式化和缩进等)
用于更高级编辑(项目列表、表格等)的WYSIWYG编辑器
预览和输出生成
了解哪些文件被记录，哪些没有，等等，以及比查看单个文件更高的级别。
浏览 1提问于2012-06-27得票数 4
2回答
Asp.Net程序员对如何记录他们的代码有什么偏好？
我用Sand城堡阅读XML是一个很好的方法。你用什么？
浏览 0提问于2011-02-16得票数 0
回答已采纳
3回答
我正在使用net beans在windows环境中开发我的应用程序。我在xml文件夹(在网页文件夹下)中有一个XML文件。我使用以下代码读取xml文件：
String path=new File("XML/TableNamesAndColumnNames.xml").getAbsolutePath();
但是找不到文件..因为我得到的路径就像-
"C:\Documents and Settings\rajesh\My Documents\NetBeansProjects\ReportOfReuls\XML\TableNamesAndColumnNames.xml"
浏览 0提问于2011-09-09得票数 0
回答已采纳
2回答
我想记录我的VB.NET网站的源代码。
如何将VB.NET ASP.NET网站中的XML注释转换为XML文档文件？
我看不到在VS网站的属性页中生成XML文档文件的选项。
浏览 4提问于2014-02-24得票数 1
回答已采纳
当URI中没有accept头或.xml后缀时，如何将jersey.java.net设置为缺省序列化？
浏览 0提问于2011-10-04得票数 10
回答已采纳
我们有一个非常古老的应用程序，可以追溯到ASP时代，我们正在逐步重构到ASP.NET + VB.NET代码库。
它包含大量如下类型的文件：
aspx、asmx、ascx、vb、js (JavaScript)、html、vbs (VBScript)。
后端数据库是具有大量存储过程的SQL Server 2005。
我们想创建一个从代码文件中的注释自动生成的代码文档。我非常喜欢Doxygen，但它似乎不支持上述技术。您能否推荐一些文档生成器工具，最好是单个工具或一组工具？
非常感谢。
阿吉特。
浏览 0提问于2009-07-21得票数 1
在Java web服务和与之对话的.NET客户端之间看到了一些奇怪的东西。我们来回发送一个带有DateTime属性的对象。有点像这样(从WSDL生成)：
[System.CodeDom.Compiler.GeneratedCodeAttribute("wsdl", "2.0.50727.3038")]
[System.SerializableAttribute()]
[System.Diagnostics.DebuggerStepThroughAttribute()]
[System.ComponentModel.DesignerCategoryAttribut
浏览 0提问于2009-03-24得票数 1
回答已采纳
我想从Visual Studio扩展中的代码文件中提取注释。有没有一种方法可以使用Visual Studio Automation来实现，而不需要自己解析代码文本？
PS:罗斯林不是一个选择，因为我并不局限于C#和VB.NET。
浏览 0提问于2020-05-11得票数 1
2回答
我想使用Doxygen来记录一个VHDL项目。对于VHDL源文件，其工作方式与预期相同。但是，我也想添加ucf (用户约束文件；Xilinx)。VHDL注释指示符"--!“显然不起作用。什么注释指示符可以用于UCF文件？
# file constr.ucf
# brief my pinout...
net "sig1" LOC = "P1"; # my signal 1
net "sig2" LOC = "P2"; # my signal 2
net "sig3" LOC = "P3"
浏览 0提问于2013-02-22得票数 2
回答已采纳
1回答
我目前正在进行一个小型库项目，使用XML定义书籍，而php使用title/author进行搜索，然后在浏览器中显示特定的书籍。所以我用XML文件做了一堆书，然后把这些文件作为外部实体链接到我的主XML文件中。我使用DTD来定义实体，用XSD文件来定义xml文件的方案(我需要使用XSD，但它不允许我定义实体，所以我也做了一个DTD )。所有文件都经过了验证，当显示一本书时，或者如果我不使用实体就将所有书籍放在同一个xml文件中，那么它就可以正常工作了。但是，当我尝试使用仅包含实体的主xml文件时，它不会识别它们，并给出以下警告而不显示任何内容：
警告: simplexml_load_file()
浏览 0提问于2020-06-23得票数 0
回答已采纳
3回答
如何在C#中注释/记录覆盖？
、、、、
有时，我重写基类中的方法。有时，我甚至用一个空方法覆盖它们，因为我想要的是防止这种行为。
在过去，我会写这样的东西，以显示绕过基本方法的意图。
protected override void OnMouseUp(MouseEventArgs e)
{
// base.OnMouseUp(e);
}
(我知道注释代码行是一件坏事。我曾经这样做过)
但我想做得更好：
如何记录重写的意图？特别是：
在覆盖的XML documentation? ((<summary>))中写什么？
浏览 1提问于2012-03-28得票数 3
回答已采纳
我需要禁用响应压缩。我有.NET 4.5版本的web.config，但现在需要在.NET Core2.x中使用。
<customBinding>
<binding name="BasicHttpBinding_Service">
<textMessageEncoding messageVersion="Soap11" />
<httpsTransport decompressionEnabled="false" />
</binding>
浏览 0提问于2018-11-30得票数 1
2回答
我正在尝试使用JAXB从一个文件中删除XML。我也有一个web服务。我不想使用名称空间，而不是web服务定义的名称空间。
我得到了以下错误：
Exception in thread "main" javax.xml.bind.UnmarshalException: unexpected element (uri:"", local:"CustomerName"). Expected elements are <{http://www.ws.NET}CustomerName>
我认为解决方案是将package-info.java文件更改
浏览 4提问于2014-09-05得票数 1
回答已采纳
1回答
以XML形式显示ASP.NET
、、、、
如何使ASP.NET页面只显示XML而不是HTML？我想要一个页面以类似于这个站点：的方式显示XML。如果您查看源，它的XML。
我在ASP.NET页面上将XML写入文字的代码。
ASP.NET页面：
<body>
<form id="form1" runat="server">
<div>
<asp:Literal ID="xmlOutput" runat="server" />
</div>
</form>
</b
浏览 1提问于2013-10-18得票数 1
回答已采纳
我想使用下面的代码插入一个节点，但是如果我要重新运行代码，我不希望我的节点被重复两次-
let $doc := fn:doc("abc.xml")
(: abc.xml looks like--
<root>
<value1>somevalue</value1>
<value2>somevalue</value2>
<value3>somevalue</value3>
<value4>somevalue</value4>
<value5>
浏览 1提问于2018-09-19得票数 0
2回答
我正在尝试使用Spring Modules项目中的声明式缓存。
它不起作用了。似乎没有缓存任何内容。
下面是我的配置：
<bean id="cacheManager"
class="org.springframework.cache.ehcache.EhCacheManagerFactoryBean">
</bean>
<bean id="cacheProviderFacade"
class="org.springmodules.cache.provider.ehcache.EhCacheFacad
浏览 11提问于2009-02-24得票数 2
回答已采纳
7回答
我知道你可以使用.net反射器来查看用.net创建的代码，但是如果我在我自己的评论中添加了一些东西，那么我自己的提醒也是在可执行文件中编译的。
我不打算发布我的应用程序的源代码，我知道100%的安全保证就是删除所有我不想要的东西，但我只是想知道是否有人可以对我的评论进行反向工程。
浏览 0提问于2009-05-04得票数 17
回答已采纳
我想在hibernate实体中声明一个瞬态方法，我们使用hbm.xml文件来实现映射，而不是注释。
我在网上很少看到有人在xml中声明字段瞬态，用注释声明方法瞬态，但我找不到在xml中声明方法瞬态的文档。我看到有人提到，如果它不在hbm.xml文件中，Hibernate将忽略它，但我想确认一下。
这方面的文档在哪里？
浏览 0提问于2019-08-13得票数 0
回答已采纳
1回答
情况
我有一个Jersey2.18API端点，它返回一个User对象。我的涉众需要API来生成一个WADL文件，该文件不仅反映API路径，而且还反映返回的对象类型。
泽西岛自2015年起使用以下端点定义，对此进行了开箱即用：
@GET
@Path("/")
@Produces({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML})
public User getExampleUser() {
User exampleUser = new User();
return exampleUser;
}
由jer
浏览 1提问于2016-03-25得票数 6
我正在向一些csharp代码添加注释，并且我使用的是.net (或其他什么)提供的XML语言。我有一个接口和一些实现类。我在接口中有一个方法，它有一个注释。在实现类中，没有关于实现方法的注释。
在java中这样做时，javadoc在生成文档时会自动使用接口注释。但是，现在我构建了我的项目，我收到警告(从瑞典语翻译过来，对不起) "the xml comment for the visible type or member bla.blabla.blablabla() is missing (cs1591)“。这只是一个警告，所以不是很糟糕。但是！这意味着没有输出xml文件，所以我不能使
浏览 4提问于2011-01-10得票数 3
回答已采纳
1回答
我读过指南，但是我找不到如何添加生成的build文档文件。我们过去常常在旧的.nuspec文件<file></file>标记中引用文件，但我找不到它的等价物。
据我所知，如果我在构建时创建xml文件，它应该自动添加到NuGet中，但是当我在下载之后检查我的nuget时，它仍然没有xml文档。
我做错什么了？
编辑1
<PropertyGroup>
<VersionPrefix>1.0.5</VersionPrefix>
<PackageVersion>1.0.5</PackageVersion&g
浏览 1提问于2017-08-23得票数 0
回答已采纳
用okular语言编写的评论高光部分存储在~/..kde/share/app/okular/docdata/中，每个带注释的*.pdf都有一个*.pdf文件。
第一个问题:如何将xml注释的路径更改为*.pdf的相同路径？因此，当我将pdf从我的计算机更改为钢笔或外部磁盘时，*.xml文件将放在同一个文件夹中，并且不会丢失在标准文件夹中。
第二个问题:下划线工具隐藏每一行的底部：
📷
为了不覆盖每个文本行的底部，我如何更正它？
为了用黄色或其他颜色划线，我编辑了一个存储在/usr/share/kde4 4/app/ okular /tools.xml中的文件。通过更改该文件，我能够为下划线添加
浏览 0提问于2016-04-21得票数 0
回答已采纳
我从一个远程位置获取一个XML文档。此文档作为字符串返回。之后，我尝试使用java解析器解析字符串。但是，有时解析会使用java.net.NoRouteToHostException中止。
我想知道异常是从哪里来的，因为据我所知，在抛出异常时，我使用的是字符串，而不是需要连接的Stream或任何其他数据格式。具有讽刺意味的是，在异常捕获中，整个字符串都是打印的，没有任何问题。
呼叫代码：
javax.xml.parsers.DocumentBuilder build = DocumentBuilderFactory.newInstance().newDocumentBuilder();
...
浏览 1提问于2014-07-14得票数 0
回答已采纳
2回答
我想知道是否有一种方法可以在android中注释部分xml代码，这样它们稍后就会出现在android studio的TODO列表中？我使用的是android studio 0.8.2。
浏览 0提问于2014-09-15得票数 20
回答已采纳
7回答
当我使用任何.NET方法时，都会有一个小提示来解释这些方法及其参数。
我如何在自己的方法中实现相同的行为？是否有Visual Studio功能允许我添加这些内容？
浏览 0提问于2011-11-24得票数 30
回答已采纳
我以这种方式执行了scbuild.ps1
set PATH=%PATH%;C:\Program Files\Sandcastle\ProductionTools
powershell
Set-ExecutionPolicy unrestricted
cd <location of dll and xml docs>
scbuild -framework 2.0 -sources <comma separated dlls and xml doc> -BuildWebsite
但是，scbuild.ps1似乎为MS Core libs (System.*)创建了xml文档
浏览 0提问于2011-11-30得票数 1
2回答
我在做一个ASP.NET网站。在这个解决方案中，我添加了另一个用作数据访问层(DAL)的项目。每当我构建项目时，dll文件都会被刷新为网站项目中的新文件。我在DAL的所有类中的每个方法之前都放置了XML注释。但是当我输入这个层的方法名时，它们是不可用的。但是，它们在自己的项目中是可见的。XML文档是否仅限内部使用？如果是这样，我如何查看其他类的XML注释？
浏览 2提问于2012-04-06得票数 5
回答已采纳
6回答
Objective-C方法注释
、、、、
为Objective-C注释方法的正确方式是什么？例如，在.Net中，我会添加如下的xml注释：
/// <summary>
/// Summary of method
/// </summary>
/// <param name="FileName">The document's original filename.</param>
/// <returns>Decoded filename</returns>
Objective-C是否有等价物？
浏览 0提问于2011-09-21得票数 19
如何在XML中编写OR关键字？
例如，我如何用XML编写这行代码？
#if (define A && define B) || (define C && !define D)
我只能找到这些：<表示<小于，>表示>大于，&表示& &符号，'表示'撇号，"表示<代码>D10</代码>引号。我应该如何更改|| OR？
浏览 201提问于2017-03-01得票数 2
1回答
在我的文档中有一个减价文件中的下面的减价片段：
```cpp
/**
Description:@depth_test: true@topology: list@line_width:输入
*/The `Input Description:` header is necesary and it is case sensitive. Also, there can only be one such comment per shader group and it must be put on the vertex shader of that group.
The valid values for
浏览 2提问于2020-06-21得票数 0
回答已采纳
3回答
我正在尝试实现一个面向客户端的SOAP处理程序。我使用的是Wildfly8.2JAX-WS和java8
我已经从端点WSDL生成了使用eclipse的客户端接口类。
handler-chain.xml文件与客户端接口放在同一个包中。
当我调用web服务时，它可以正常执行，但处理程序没有被调用。如果我在处理程序中设置了一个刹车点，它永远不会被调用
客户端界面如下所示：
@WebService(targetNamespace = "********************", name = "WorkflowEditor")
@XmlSeeAlso({ Object
浏览 0提问于2015-08-28得票数 6
回答已采纳
扫码
添加站长 进交流群
领取专属 10元无门槛券
手把手带您无忧上云
相关资讯
热门标签
云服务器
ICP备案
实时音视频
即时通信 IM
对象存储活动推荐
腾讯云开发者
