Comments for program code that are written in XML.
Questions tagged [xml-comments]
280 questions
0
votes
1 answer
Ordered lists in Doxygen comments from C# .NET comments
I've got some C# documentation comments that looks like this:
///
/// Pre-Conditions:
///
///
/// 1. The sky must be clear.
///
///
/// 2. It must be night time.
///
///
///…
Don 01001100
- 1,450
- 18
- 42
0
votes
2 answers
How to autocorrect xml documentation of methods
In the below code in xml documentations there is mismatch between the names of parameters in method's arguments and name of parameters in xml documentation. Is there any way to auto correct the xml documentation signature or any feature provided in…
Raghav
- 6,381
- 4
- 60
- 85
0
votes
1 answer
Remove empty comment tags using XSLT
I have an input xml suppose of the form
Vix
- 53
- 7
0
votes
1 answer
GhostDoc - Updating derived class comments
I have an interface (ISomeInterface) with full xml comments, and some derived classes with matching xml comments.
If I change the comment in the interface, is it possible to update the comments in all derived classes with GhostDoc (or any other…
Brett Postin
- 10,721
- 9
- 58
- 93
0
votes
1 answer
Finding uncommented methods in a C# project
Is there a way to find the number of methods in the assembly which do not have any xml comment on them.
public int Sum(int i, int j)
{
....
}
AsitK
- 631
- 4
- 13
0
votes
1 answer
Generate JavaScript Intellisense Documentation Comments with CoffeScript
I am working with CoffeeScript and I want to supply Visual Studio 2010 JavaScript Intellisense hints as for example Jquery does.
The comments have to be in the format
///Description of the Function
The only way I can see to…
0
votes
2 answers
Putting comments in XML that is present in my C# XML comment blocks
I am using a code example block in an XML comment as a simple way to give the user an idea of what the XML looks like. This is a very rough solution and the user will eventually be provided with XML Schema for the xml string. However, for now I'm…
Dave
- 13,797
- 12
- 80
- 140
-1
votes
2 answers
Automatically remove comments from source control or keep code comments in separate physical files
Is it possible to automatically remove code comments in Visual Studio files before committing to source control, or is it possible to virtually have comments in files but physically store those in separate files?
The end goal is not to have comments…
BuzzBubba
- 693
- 1
- 8
- 20
-1
votes
1 answer
Punctuation marks in C# XML comments
Should I add punctuation marks (e. g. ".") in my c# xml comments?
In the official Microsoft xml comment documentation there is now statement.
Also you can see in that in this documentation there are some comments with an ending "." and some…
sampa
- 395
- 3
- 17
-1
votes
2 answers
Sandcastle not generating params or return
I have a Visual Studio C# project with XML documentation comments. I get a .xml file with , , and members.
The text I put inbetween the tags is shown in the help file as well as Namespace, Assembly,…
Simon
- 85
- 6