xml-documentation

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 warnings when public, protected, or internal protected members are not documented, I am looking for a way to have the private and internal mem...

Where to put the XML documentation comments for an attached property ?

Hi all, Assuming I have an attached property defined like that : public static string GetMyProperty(DependencyObject obj) { return (string)obj.GetValue(MyPropertyProperty); } public static void SetMyProperty(DependencyObject obj, string value) { obj.SetValue(MyPropertyProperty, value); } //...

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 relation to the <see cref="Get"/> methods. /// </summary> I get a blue squiggly under Get, saying that it is an Ambiguous reference 'Get'. which...

Are there any standards for visually depicting XML file structures or schemas?

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 Microsoft Visio drawings. I'm a fan of self-documentation, but this isn't my choice - external documentation must be produced. How can I depict t...

Need to choose a suitable language to write documentation in

Currently the documentation where I work is in a bit of a state. There isn't anywhere near enough of it, and the documentation that does exist is spread out over many word documents making it hard to find anything. I'm trying to take some initiative and get it improved, and I figure the first thing is to find a better format to write ...

Is there a tool to convert Javadoc into C# XML documentation?

Does anyone know of a tool that converts Javadoc comments into C# documentation comments? ...

How to document the structure of XML files

When it comes to documenting the structure of XML files... One of my cooworkers does it in a Word table: Another pastes the elements into a Word document with comments like this: <objectRoot> <v> <!-- Current version of the object from the repository. !--> <!-- (Occurance: 1) --> </v> <label> <!-- Name of the object from t...

What's the meaning of the hashes at Enumerations?

I use GhostDoc for the XML-Documentation of my code, and it has a neat "auto-document"-function I use quite often, so now I used it on an enumeration and it came up with some strange hash-code I don't quite understand. What is it for? Looks sort of like this: {35A90EBF-F421-44A3-BE3A-47C72AFE47FE} ...

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 after, a Release build (which excludes all my test projects), I selected "Release" at the top of the window, just like in VS. Sandcastle ap...

merged DLLs, Intellisense not picking up separate XML doc files

I use ILMerge to merge several of my C# project DLLs into a single DLL for the whole solution. I have each project produce a .XML file of its documentation for Intellisense, and I'm having trouble getting those comments to show up when I try to use my merged DLL as a reference in another solution. I have these files all in the same dir...

Is there a tool which allows easy writing of documentation from an XML schema?

My application uses an XML file of some complexity for configuration. It's not much - about two dozen elements - but still non-trivial. Currently I'm writing XML schema for it, and was wondering if there was a tool which would generate documentation from this schema? Something human-readable that can be used by a person who has to write...

Is there a way 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 name="AddressType"> <xsd:annotation> <xsd:documentation>A formatted or free form address and its intended use.</xsd:documentation> </x...

Visual Studio XML Documentation...library ?

Hi everybody, Is there a software/app that could stored all our VS2008 XML documentation comments files in one place and could act as a library for all this doc ? We are creating many web projects that are all interconnected, and we need to put in 1 place all the XML docs created by VS. So it could act as a place where we could access ...

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 documentation file using my XML documentation, it's always formatted nicely and respects the newlines in my <code> blocks. However, when I browse the classes and methods in...

How to scan a mixed mode C++/CLI assembly to create the intellisense XML?

We have a C++/CLI mixed mode assembly out of which we produce an XML file that we use for both, Sandcastle documentation and Intellisense. We use a tool which scans the assembly and create all entries for us, unfortunately I don't know how this tool works and it is unable to handle method signatures like: void foo([Out] long bar); T...

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: I am defining an I*View interface for each web page/user control based on WCSF paradigm, then have the page class implement the I*View inte...

Show <returns> xml tag into visual studio intellisense

Hi , I added the xml tag to some of my methods but I can't see its content in the intellisense here is my code /// <summary> /// we all live in a yellow summary /// </summary> /// <returns>what it returns</returns> public int MyMethod() { .... } Do you have any idea ? Thanks ...

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="someParam">Specifies some option</param> /// <returns>true if it worked</returns> bool DoStuff( bool someParam ); I find myself re-typing those blocks quite...

How to refer to enum constants in c# xml docs

I want to document the default value of an enum typed field: /// <summary> /// The default value is <see cref="Orientation.Horizontal" />. /// </summary> public Orientation BoxOrientation; The compiler warns that it couldn't resolve the reference. Prefixing F: or M: silences the compiler, but E: also does, so I'm unsure what prefix i...

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="NumberStyles"/> it works perfectly. If I try to refer an enum value like <see cref="NumberStyles.AllowTrailingWhite"/> I get a link in the documentatio...