Questions tagged «xml-documentation»

编写xml文档时，您可以使用<see cref="something">something</see>，这当然可以工作。但是，如何引用具有泛型类型的类或方法？ public class FancyClass<T> { public string FancyMethod<K>(T value) { return "something fancy"; } } 如果我要在某处编写xml文档，我将如何引用这个花哨的类？我该如何引用FancyClass<string>？那方法呢？ 例如，在另一个类中，我想让用户知道我将返回的实例FancyClass<int>。我该如何为此做一个见识参考资料呢？

198 c#  generics  reference  xml-documentation 

这应该更容易... 我想在代码中的XML文档中添加一个“编码”换行符 /// <summary> /// Get a human-readable variant of the SQL WHERE statement of the search element. <br/> /// Rather than return SQL, this method returns a string with icon-tokens, which /// could be used to represent the search in a condensed pictogram format. /// </summary> 如您所见，我发现了一些答案，这些答案说明了添加<和>方括号。有趣的是，好的'ol <br />换行符不会在Intellisense弹出窗口中创建换行符。 …

196 c#  .net  xml-documentation 

用于将XmlDoc集成到Web Api项目中的文档似乎仅用于处理所有API类型都属于WebApi项目的情况。特别是，它讨论了如何将XML文档重新路由到App_Data/XmlDocument.xml配置中的一行并取消注释该行，该行将占用该文件。这隐含地只允许一个项目的文档文件。 但是，在我的设置中，我的请求和响应类型在常见的“模型”项目中定义。这意味着如果我定义了一个端点，例如： [Route("auth/openid/login")] public async Task<AuthenticationResponse> Login(OpenIdLoginRequest request) { ... } 在OpenIdLoginRequest单独的C＃项目中定义where ，如下所示： public class OpenIdLoginRequest { /// <summary> /// Represents the OpenId provider that authenticated the user. (i.e. Facebook, Google, etc.) /// </summary> [Required] public string Provider { get; set; } ... } 尽管有XML文档，但是request当您查看特定于端点的帮助页面（即http://localhost/Help/Api/POST-auth-openid-login）时，该参数的属性不包含任何文档。 如何使带有XML文档的子项目中的类型出现在Web API XML文档中？

102 c#  asp.net-web-api  xml-documentation 

已关闭。这个问题是基于观点的。它当前不接受答案。 想改善这个问题吗？更新问题，以便通过编辑此帖子以事实和引用的形式回答。 2年前关闭。 改善这个问题 是否有自动的方法在界面及其实现之间同步注释？我目前正在记录它们，并且不想手动保持它们同步。 更新： 考虑以下代码： interface IFoo{ /// <summary> /// Commenting DoThis method /// </summary> void DoThis(); } class Foo : IFoo { public void DoThis(); } 当我创建这样的类时： IFoo foo=new Foo(); foo.DoThis();//comments are shown in intellisense 这里的注释未显示： Foo foo=new Foo(); foo.DoThis();//comments are not shown in intellisense 的 <inheritDoc/>标签将完美地在Sand …

98 c#  documentation  xml-documentation