xml-comments

问题 I have writen a method such as: /// <summary> /// A method having xml-comments /// This comment could be very long /// </summary> /// <param name="input">Input parameter</param> /// <returns>Calculated value</returns> int CommmentedMethod(int input) { return Calc(input); } But when I use this method, Visual Studio (I'm using VS 2010) just show up " A method having xml-comments This comment could be... " not a full document. Is there an option to show it? Updated picture: Thanks :-) 回答1: You

问题 I have writen a method such as: /// <summary> /// A method having xml-comments /// This comment could be very long /// </summary> /// <param name="input">Input parameter</param> /// <returns>Calculated value</returns> int CommmentedMethod(int input) { return Calc(input); } But when I use this method, Visual Studio (I'm using VS 2010) just show up " A method having xml-comments This comment could be... " not a full document. Is there an option to show it? Updated picture: Thanks :-) 回答1: You

问题 We have several projects that use runtime T4 Templates. The T4 Template files (.tt) produce generated .cs files with the same name. These contain a TransformText() method and a ToStringHelper() method which do not contain XML comments. We generate XML documentation for all of our projects, so the lack of it on these two methods causes persistent warnings during compilation. My question is, does anyone know how to get these two generated methods to have XML documentation? Thanks for any

问题 I used the LINQ to SQL designer in Visual Studio to create an object model of a database. Now, I want to add XML comments to each generated property but I can't figure out how to do it without erasing the properties the next time the dbml file is refreshed. How can this be done? 回答1: I believe it's not possible to keep xml comments in sync with autogenerated code automatically. However, xml comments can leave in separate file (just set "XML documentation file" option on "Project properties"->

问题 I have the following problem with my EDMX file. In it I have written some Documentation for the properties as well as the Entities, but the t4 template of my EF 5 doesnt generate those values. My desired result should be public class Person { /// <summary> /// Hello World Summary!! /// </summary> /// <remarks> /// Hello World Remarks!! /// </remarks> public string Name { get; set; } } But I only get public class Person { public string Name { get; set; } } And if not for this, why would I else

问题 I'm using Visual Studio 2008 SP1 in VB.NET, when I type ''' above a function, some automatic default XML comments appear: ''' <summary> ''' ''' </summary> ''' <remarks></remarks> I would like this to be the following instead: ''' <summary></summary> ''' <remarks></remarks> Is there a way to change what appears when you type ''' above a function? 回答1: They key is in the VBXMLDoc.xml file. It provides templating for all of the XML comments in VB.NET. Still have not checked if there is a

问题 When I type "///" in the editor, Visual Studio creates an empty comment body with the < summary > and other tags. I can then type the "<" and VS suggests a list of recommended tags. How can I make the IntelliSense to suggest my custom tags here? Ideally, I would like to have my own XML documentation template expanded when I type "///" 回答1: Have a look at this. It is primarily targeted at VS2005 en 2008, but it's probably still valid for 2010 with minor differences. Documenting Your Code With

问题 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 . So far I understand that its good practice to XML comment a classes methods but is there a standard for how much you should use XML

问题 I read all questions about intellisense problems but my intellisense doesn't work. Visual Studio Ultimate 2013 I don't use any extension like Resharper, ghostdoc and so on All XML documentation files about custom and not custom classes are inside starter project's /bin folder . ( Build -> generate XML doc is ON ) I have all documentations browsable via Object Browsers Intellisense doesn't show tooltip information about . NET classes /EF/Identity too Intellisense shows tooltip information only

问题 This rather is a verification just not to miss out. Is/n't there a line-comment in XML? So, one without a closer, like "//" the compiler uses. I saw How do I comment out a block of tags in XML? and several other discussions. This type of comment would be practical to comment out a line without bothering its closer somewhere down. 回答1: No, there is no way to comment a line in XML and have the comment end automatically on a linebreak. XML has only one definition for a comment: '<!--' ((Char - '