313 questions
254 votes
8 answers
153k views
Visual Studio Disabling Missing XML Comment Warning
I have a project with over 500 Missing XML Comment warnings. I know I can remove the XML Comment feature, or paste empty comment snippets everywhere, but I'd prefer a generic solution where I can ...
157 votes
12 answers
183k views
How to have comments in IntelliSense for function in Visual Studio?
In Visual Studio and C#, when using a built in function such as ToString(), IntelliSense shows a yellow box explaining what it does. How can I have that for functions and properties I write?
141 votes
5 answers
523k views
How can I comment a single line in XML?
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 ...
90 votes
3 answers
43k views
XML Auto Commenting C# in Visual Studio Code
In MonoDevelop, when I type "///", it auto-generates an xml-style comment like this: /// <summary> /// Describes the variable x /// </summary> int x = 0; Is there a way to get this ...
76 votes
4 answers
33k views
How do I comment attributes inside an XML tag?
Is it possible to comment one or several attributes inside an XML tag? Something like /* */ from C. I have tried using <!-- -->, but it was unsuccessful. <element attribute1="value1" ...
50 votes
5 answers
24k views
C# XML /// Comments, where does <returns></returns> tag show up?
I am currently a programming student, and obviously my question is simple, but I haven't been able to find the answer to it online. So here it is: In XML /// comments in C#, where does the <...
32 votes
4 answers
18k views
XML multiline comments in C# - what am I doing wrong?
According to this article, it's possible to get multiline XML comments -- instead of using ///, use /** */. This is my interpretation of what multiline comments are, and what I want to have happen: /...
29 votes
2 answers
3k views
What does the filterpriority tag in an XML comment do?
I have seen this in a lot of XML comments for classes in the .NET Framework BCL but have never been able to find documentation that explains what it does. As an example, looking at System.Object ...
28 votes
3 answers
5k views
Can ConfigurationManager retain XML comments on Save()?
I've written a small utility that allows me to change a simple AppSetting for another application's App.config file, and then save the changes: //save a backup copy first. var cfg = ...
28 votes
3 answers
9k views
Change default XML comment snippet in Visual Studio
When I hit /// in Visual Studio, is it possible to change the resulting snippet from this: /// <summary> /// /// </summary> to this?: /// <summary></summary>
25 votes
1 answer
5k views
XML Commenting on partial classes/methods
Is there a standard way that the tools used to generate the API documents handle having XML Style comments on partial classes? Basically, how should one comment a partial class/method so that the ...
25 votes
3 answers
5k views
XML Comments - Should see references be fully qualified?
Basically, when is it truly necessary (if at all) to use a fully qualified xml see reference: <see cref="T:MyNamespace.Sub.MyType"/> //Option 1 <see cref="T:MyType"> //Option 2 Also, what ...
24 votes
6 answers
7k views
At what point do Stylecop settings stop being useful and start becoming annoying?
I work in a team where we use extensive ruleset in StyleCop and I am wondering what are the thoughts on the general point where such a tool stops being useful and starts becomes annoying. We also use ...
23 votes
5 answers
15k views
What is the purpose of remarks tag in c#
I understand that remarks tag is used to provide additional information about the class but it is not displayed in intellisense while hovering / calling that class. I would like to know Where exactly ...
21 votes
6 answers
4k views
.Net XML comment into API Documentation
Is there an easy way to produce MSDN-style documentation from the Visual Studio XML output? I'm not patient enough to set up a good xslt for it because I know I'm not the first person to cross this ...