xml-documentation

Extract xml comments for public members only

由 ≡放荡痞女 提交于 2019-12-12 09:30:01
问题 I'm using xml comments to document public as well as internal and private members of my components. I would like to package the generated documentation xml files with component assemblies in order to enable "rich" (e.g. with method, exceptions and parameter descriptions) Visual Studio Intellisense with the end product. The problem with it is that the C# compiler creates documentation entries for everything (including internal classes, methods, private fields of internal enums etc.) and there

Website project: want to generate XML documentation on build

由 社会主义新天地 提交于 2019-12-11 11:14:06
问题 For legacy reasons, I'm maintaining a Web Site Project for which I want to provide up-to-date documentation from the XML documentation comments. I gather I can do that by tweaking the <compilers> section in web.config . I finally reached this point: <system.codedom> <compilers> <compiler language="c#;cs;csharp" extension=".cs" type="Microsoft.CSharp.CSharpCodeProvider" compilerOptions="/optimize /doc:C:\temp\my-output-here.xml" warningLevel="1" /> </compilers> </system.codedom> Now when I

C# how to deserialize an xml tag embedded in text?

由 ￣綄美尐妖づ 提交于 2019-12-11 01:33:12
问题 I am trying to deserialize the output of .NET's XML doc comment using an XmlSerializer. For reference, the output of xml documentation looks like: <?xml version="1.0"?> <doc> <assembly> <name>Apt.Lib.Data.Product</name> </assembly> <members> <member name="P:MyNamespace.MyType.MyProperty"> <summary>See <see cref="T:MyNamespace.MyOthertype"/> for more info</summary> </member> ... </members> </doc> The object I'm using to generate the serializer is: [XmlRoot("doc")] public class XmlDocumentation

Generics in XML documentation issue

由 [亡魂溺海] 提交于 2019-12-10 15:08:54
问题 I am trying to include a code snippet in my class XML documentation but the compiler complaining that an xml element is not closed! Here is what I am trying to achieve /// <summary> /// Method documentation here... /// </summary> /// <remarks> /// <para> /// This class should be used as follow: /// <br/> /// ************** PROBLEM IN NEXT LINE ******************** /// <c> MyClass class = new MyClass<String>(); </c> /// </para> /// </remarks> public class MyClass<T>{ .... } I tried to replace

How should comments for interface and class methods be different

由 前提是你 提交于 2019-12-10 15:08:12
问题 I ran into this dilemma when working on an ASP.net web application using Web Client Software Factory(WCSF) in C#, and the same could apply to other platform and languages. My situation is like this: I am defining an I View interface for each web page/user control based on WCSF paradigm, then have the page class implement the I View interface, basically implementing each of the methods defined in the interface. When I tried to add xml-documentation on the method level, I found myself basically

Visual Studio: Warn on Missing XML Documentation for Private and Internal Members

由 孤街醉人 提交于 2019-12-10 14:05:14
问题 I am using Visual Studio 2005 (VS.8.0) and I am looking to enforce the requirement that all class members, not just the public ones, be documented. While trivial to setup Visual Studio to generate warnings when public, protected, or internal protected members are not documented, I am looking for a way to have the private and internal members throw this same warning. Any suggestions? NOTE: I am using warning level 4, am treating Warnings as Errors, and have the Generate XML flag set. 回答1:

Are XML documentation tags not being handled by Web API 2 help pages?

由 时光怂恿深爱的人放手 提交于 2019-12-09 11:52:15
问题 I'm trying to use <see cref=""> tags in my XML documentation tags for my API, but they are coming up blank in the Help pages. So, for a Description I'd like it to say: "Gets or sets the value for the associated Item ." Where Item is a link to another object in the API. Instead, I'm getting: "Gets or sets the value for the associated ." So the <see cref=""> tag is being ignored. I've even tried using examples from here just in case my declaration was wrong, but that didn't work either. Has

NuGet Package not copying XMLDoc file along with dll to bin

由 点点圈 提交于 2019-12-09 03:32:25
问题 I'm using NuGet GUI and trying to include XML File along with my DLL to distribute help along with the DLL. When I install package in any of the project, it adds the DLL reference successfully, but XML file is not generated inside bin folder of the project in which package is added. XML file is available within packages\\lib\.XML Any help would be very much appreciated. Thanks in advance 回答1: On your side of things: Check this post: How do you include Xml Docs for a class library in a NuGet

XML Documentation: <see> tag with multiple generic type parameters

由 瘦欲@ 提交于 2019-12-07 12:31:15
问题 I'm trying to use XML documentation on the members of a class, and in a certain case I would like to reference a generic type using a tag. The problem here is that a warning is generated when multiple generic type parameters are specified. It was easy enough to find how to reference a generic type with a single parameter, as such: <see cref="Func{int}" /> However, trying something like this generates the warning: <see cref="Func{int, bool}" /> It seems that I am either using the wrong syntax

XML Documentation: <see> tag with multiple generic type parameters

由 自古美人都是妖i 提交于 2019-12-05 23:27:36
I'm trying to use XML documentation on the members of a class, and in a certain case I would like to reference a generic type using a tag. The problem here is that a warning is generated when multiple generic type parameters are specified. It was easy enough to find how to reference a generic type with a single parameter, as such: <see cref="Func{int}" /> However, trying something like this generates the warning: <see cref="Func{int, bool}" /> It seems that I am either using the wrong syntax for references with more than one type parameter, or such references are not currently supported in XML
订阅 xml-documentation