How to link / rearrange groups in C # XML comments?

In the documentaiton XML comments for C #, is there a way to mark two or more functions that will overload each other so that they automatically refer to each other? Ideally, they will also be grouped together in documentation created in the style of a sand castle.

Purpose: often I want to associate this group of functions, for example. in the list of utility functions, just mention one of the overloads and make the rest readily available there.

I am currently adding links, but this is tedious.

+6
c # overloading xml-comments sandcastle
source share
2 answers

The relationship between multiple congestion has already been identified and grouped according to the XMl and Sandcastle documentation.

seealso to other elements using see or seealso .

Eg.

 ///See <see cref="M:AnotherMethod(System.String)"> 

I found that the resolution of the Sandcastle element might be a little flaky, so I tend to use fully qualified names.

 ///See <see cref="M:MyCompany.Myapp.MyClass.AnotherMethod(System.String)"> 

Note: M: indicates that the element is referenced, you also use E: to indicate the Event. T: used for type, but assumed if not.

+2
source share

Grouping is done automatically by Sandcastle, on the right, but if you want to provide the overload group with a general description, use the <loads> tag for this (same as <summary>). It is not a standard XML documentation tag, but AFAIR is supported by Sandbule Help File Builder.

+1
source share

All Articles