397 questions
0
votes
1
answer
519
views
How to I represent a '<' character in my XML documentation?
I've seen various questions here on SO involving Microsoft's XML documentation tags, but I'm having trouble adding some example code:
/// <summary>Return the oldest acceptable timestamp for a ...
- 37.8k
1
vote
3
answers
349
views
How programmatically extract type description which is shown by intellisense as hint
When I type some Class, e.g. Console, then press ctrl+space and intellisense show hint "Class System.Console Represents standart input, output and error streams...."
How programmatically get this text....
- 11
2
votes
2
answers
418
views
How do you add folder level documentation to C# assemblies?
Me: I'm a relative new-comer to the .NET platform.
Problem
In Java, you can add package level documentation to your project by creating a package-info.java or package.html file and storing in the ...
- 13.7k
6
votes
1
answer
3k
views
Documenting using Sandcastle: Refering to enum value using <see>
I'm using Sandcastle 2.4.10520 and Sandcastle Help File Builder 1.8.0 to generate a .chm help file.
In my documentation, I'm using <see> tags.
If I try to refer an enum like <see cref="...
- 6,585
0
votes
3
answers
139
views
Is there any way to get Visual Studio 2008 to update .net style comments automatically?
I've been writing a lot of VC++ 2008 / CLI software recently and am using the C#/CLI style documentation:
/// <summary>
/// Function the does stuff
/// </summary>
/// <param name="...
- 37.8k
7
votes
2
answers
3k
views
How should comments for interface and class methods be different
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:
...
- 615
5
votes
1
answer
769
views
Visual Studio Object Browser disregards XML comment formatting
In my .NET XML comments on methods and classes, I try to provide usage examples in <example><code></code></example> blocks. When I use Sandcastle to generate a .chm ...
- 31.8k
12
votes
2
answers
4k
views
How to include the xsd:documentation in the C# class generated with XSD.exe?
I am using xsd.exe to generate a C# class from a collection of xsd files. The xsd file makes use of the <xsd:documentation> tag to include useful descriptions. Example:
<xsd:complexType ...
- 38.8k
1
vote
1
answer
422
views
Sandcastle Distinguishes Between Debug and Release Builds?
I fired up Sandcastle Help File Builder today to generate documentation for my solution, which has around a dozen projects in it. Since I only want to generate documentation for, and run Sandcastle ...
- 1,313
29
votes
6
answers
39k
views
How to document the structure of XML files
When it comes to documenting the structure of XML files...
One of my co-workers does it in a Word table.
Another pastes the elements into a Word document with comments like this:
<...
- 17.6k
48
votes
1
answer
13k
views
How do you get XML comments to appear in a different project (dll)?
/// <summary>
/// This method does something...
/// </summary>
public void DoSomething()
{
// code...
}
When using that method/class etc... in a different .dll the comments do not ...
- 15.8k
0
votes
1
answer
306
views
Are there any standards for visually depicting XML file structures or schemas? [closed]
I have some XML files and schemas that I would like to document. Everything for this project is documented using NetBeans UML models, Microsoft Word documents, Microsoft Excel spreadsheets, and ...
- 117k
35
votes
2
answers
5k
views
C#, XmlDoc: How to reference method overloads
If I have these two methods
public Foo Get(string bar) { ... }
public Foo Get(int bar) { ... }
And write this piece of xml documentation on a different method
/// <summary>
/// Has a close ...
- 159k
5
votes
1
answer
1k
views
Visual Studio: Warn on Missing XML Documentation for Private and Internal Members
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 ...
- 605
1
vote
1
answer
323
views
How to get Emacs fill-paragraph to work on inline XML code doc in my C# modules?
This question is similar to Getting Emacs fill-paragraph to play nice with javadoc-like comments, but for C#.
I have comments like this:
/// <summary>
/// Of these Colonies, and ought to fall ...
- 193k
106
votes
9
answers
37k
views
Ways to synchronize interface and implementation comments in C#
Are there automatic ways to sync comments between an interface and its implementation? I'm currently documenting them both and wouldn't like to manually keep them in sync.
UPDATE:
Consider this code:
...
- 25.9k
2
votes
1
answer
1k
views
Reference Prefixes in .NET XML Documentation
I've been attempting to fully document all types, methods, properties, etc. of a class library using XML comments but have run into a curious effect involving the cref attribute (used by see tags for ...
- 148k
7
votes
4
answers
3k
views
XML Documentation Comments with Interfaces and implementing class(es) [closed]
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 ...
- 54.3k
87
votes
1
answer
22k
views
How do I reference a C# keyword in XML documentation?
<see cref="switch" />, for example, doesn't work - I get the compilation warning: XML comment on ... has syntactically incorrect cref attribute 'switch'
Context for those who are interested...
/...
- 58.1k
19
votes
4
answers
14k
views
How to use XML documentation files
When using an external assembly which comes with an XML documentation file, how do I get visual studio to find it?
When having an XML documentation file, is there a program or xml transform file or ...
- 159k
20
votes
6
answers
3k
views
Extract xml comments for public members only
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 ...
- 11.4k
266
votes
8
answers
81k
views
How to reference generic classes and methods in xml documentation
When writing xml documentation you can use <see cref="something">something</see>, which works of course. But how do you reference a class or a method with generic types?
public class ...
- 159k
25
votes
3
answers
9k
views
How to make a cref to method overloads in a <seealso> tag in C#?
I see in MSDN links such as "CompareOrdinal Overloads". How can I write such a link in C#?
I tried:
<seealso cref="MyMethod">MyMethod Overloads</seealso>
But the compiler gives me a ...
- 42.6k
21
votes
7
answers
25k
views
How do I export the code documentation in C# / VisualStudio 2008?
I have always made a point of writing nice code comments for classes and methods with the C# xml syntax. I always expected to easily be able to export them later on.
Today I actually have to do so, ...
- 70.8k