xml-documentation

问题 As it currently stands, this question is not a good fit for our Q&A format. We expect answers to be supported by facts, references, or expertise, but this question will likely solicit debate, arguments, polling, or extended discussion. If you feel that this question can be improved and possibly reopened, visit the help center for guidance. Closed 7 years ago . I'm looking for a free authoring tool to author XML Documentation in Visual Studio 2010. I know Document! X but i'm looking for a free

问题 In a C# class with a single constructor, I can add class summary XML documentation and constructor XML documentation: ///<summary> ///This class will solve all your problems ///</summary> public class Awesome { /// <summary> /// Initializes a new instance of the <see cref="Awesome"/> class. /// </summary> /// <param name="sauce">The secret sauce.</param> public Awesome(string sauce) { //...implementation elided for security purposes } } How do I do the same with the equivalent F# class such

问题 Closed. This question is off-topic. It is not currently accepting answers. Want to improve this question? Update the question so it's on-topic for Stack Overflow. Closed last year . I would like some tool, preferably one that plugs into VS 2008/2010, that will go through my methods and add XML comments about the possible exceptions they can throw. I don't want the <summary> or other XML tags to be generated for me because I'll fill those out myself, but it would be nice if even on private /

问题 I have a webapi project, and I am utilizing the swashbuckle framework to flush out api documentation. I have followed the directions to build the documentation xml file with my controller and DTO's, and it all works great locally. However, when generating the swagger document, a 500 error is thrown. I have confirmed if i remove my xml registration line, the swagger doc is generated and returned successfully. here is my registration line: GlobalConfiguration.Configuration.EnableSwagger(c => {

问题 there is an IDE Plugin out there (I think it was not free) which assists in writing XMLDocumention inside the IDE. I tried to search for it, but I cannot find it anymore. Anybody knows it? 回答1: Try using Documentation Insight from DevJet 来源： https://stackoverflow.com/questions/4713349/ide-plugin-for-xmldoc

问题 There is ///<summary> ///This is summary for some class or method ///</summary> documentation for classes or methods. But how to write this for simple variables or lists? I use Visual Studio 2010 and when i hover over some list, property or what ever i would like to see some kind of summary (in that little tooltip) i have written to that specific thing. ///<doc> ///always use this list! List<String> beer = new List<String>(); edit: ok, we have found out, that it works as usual as long u

问题 /// <summary> /// This method does something... /// </summary> public void DoSomething() { // code... } When using that method/class etc... in a different .dll the comments do not show up. 回答1: A couple of suggestions: Make sure that your compiler is configured to emit the XML doc comments as part of the compilation job The Microsoft C# compiler switch that controls this is /doc , and can also be configured via the Build property page in a project's settings Make sure that the XML file

问题 This should be waaaay easier... I want to add a "coded" line break to the XML documentation in my code /// <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> As you can see, I found some answers that demonstrated adding < and > brackets. Interestingly, the good 'ol < br/ > line

问题 My code contains a class with one method that returns an object that was originally passed as a parameter to another method. I would like to indicate this relationship in the XML documentation mark-up. class XmlDocThing { /// <summary> /// Documentation for the other method. /// </summary> /// <param name="howDoIReferToThis">Magic object.</param> public void AnotherMethod(object howDoIReferToThis) { } /// <summary> /// Documentation for this method. /// </summary> /// <returns>The object

问题 Closed . This question needs to be more focused. It is not currently accepting answers. Want to improve this question? Update the question so it focuses on one problem only by editing this post. Closed last year . I am documenting an assembly using XML Documentation Comments, from which a chm file will be created using Sandcastle. My assembly contains various interfaces, each of which is implemented by one class (in my scenario these are WCF services). I have added documentation to the