313 questions
8
votes
2
answers
4k
views
How to specify the Type in an XML Comment <return> comment
In my C# XML Comment's <return> comment, I would like the output (I'm using Sandcastle) to specify the Type that is returned, but I am unable to find out how to do that.
Psuedo Example:
///<...
- 10.9k
1
vote
1
answer
918
views
How to triple-slash selected text in Visual Studio 2010
In Visual Studio 2010 we can Comment selected text via Ctrl+E,C - This prefixes selected lines with the double-slash.
Is there a way to select text and have VS2010 prefix the selected lines with a ...
- 10.9k
0
votes
1
answer
315
views
Atomineer Utils VB.NET XML Comment Documentation Not Working
I just downloaded the trial for this application and it doesn't seem to work. I went through the Quick Setup guide and it all looked great. Now when I place my cursor on a member of any type and press ...
- 2,643
0
votes
1
answer
140
views
XQuery and Server Sides Includes
How can I instruct XQuery to copy these SSI directives (HTML comments) from an XQuery file (.xq) to the output html file.
<!--#set var="tab4" value="true" -->
<!--#include virtual="/common/...
- 5,861
7
votes
1
answer
2k
views
Visual Studio 2010 SDK -- How to place an adornment next to XML comment groups?
I'm having trouble finding out how to do this and the Visual Studio SDK Reference is not very helpful either.
I'm trying to figure out how to get a NormalizedSnapshotSpanCollection of XML comments. I ...
- 15.4k
1
vote
1
answer
1k
views
T4 Template TransformText method XML Documentation
We have several projects that use runtime T4 Templates. The T4 Template files (.tt) produce generated .cs files with the same name. These contain a TransformText() method and a ToStringHelper() method ...
- 12.9k
6
votes
2
answers
2k
views
Getting Intellisense on the interface that a method implements if that method does not have its own XML comments
In Visual Studio 2010 is there a way to get Intellisense on the Interface that a method implements if that method does not have any XML comments of its own?
I suppose something like this would be ...
- 4,090
2
votes
1
answer
709
views
How to convert metadata comments into summary comments
I want to write a wrapper class for the set of existing classes. When I go to the definition of existing class it shows meta-data file with comments like
// Summary:
// This is Test ...
- 3,332
10
votes
1
answer
2k
views
Why I can't see xml comments from external library?
Is it normal I can't see xml comments from external libraries?
For example I have an external library with xml comments on methods. After making a reference to this library I was hoping that xml ...
- 13.9k
16
votes
2
answers
6k
views
How to make Visual Studio intellisense to show the remarks portion of XML comments?
When typing code, I really like the intellisense feature of Visual Studio 2010 (Professional), especially that I am able to look up XML comments of types in use. (See Documentation from Microsoft). ...
- 15.8k
6
votes
1
answer
1k
views
constructed generic type in cref part of xml-comment
I have generic exception class like this:
public class DuplicateException<TEntity> : Exception
{
public TEntity Entity { get; set; }
}
And I have non-generic method which might throw ...
- 17.3k
6
votes
3
answers
705
views
Class Documentation Suggestions
We are a Microsoft shop, concentrated on using C#. We have several projects, including websites, Windows services, and class libraries, that incorporate XML comments.
I'm looking to generate MSDN-...
- 1,386
-1
votes
2
answers
2k
views
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 ...
- 733
1
vote
3
answers
2k
views
Double-Asterisk Comment Notation in XML
Is it valid to use a double-asterisk to indicate a line-comment in XML? I see this a lot in the XML files I've been assigned to parse.
Example:
</someClosingTag>
** This is my line comment in ...
- 14.4k
1
vote
3
answers
205
views
Is there a way to prevent the loss of comments in my web.config if I use Visual Studio's settings editor?
I'm using the settings editor in Visual Studio 2010 to add/edit/remove my settings from the section of my .NET 4 web.config file.
Here's a (pretty vague) example extract to illustrate the bit I mean:...
- 3,131
6
votes
1
answer
863
views
Sandcastle/SHFB. Add platform icons and version info to help file pages
I am building help file for my library using Sandcastle Help File Builder. The library has three versions (.NET, Silverlight and Windows Phone 7) built from the same code base.
I would like to add ...
- 14.3k
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 ...
- 5,492
2
votes
3
answers
885
views
Difference between c and code tags
In C# xml comments, what is the difference between the tags below?
1. <c>
2. <code>
- 10.2k
4
votes
3
answers
1k
views
pyparsing - parse xml comment
I need to parse a file containing xml comments. Specifically it's a c# file using the MS /// convention.
From this I'd need to pull out foobar, or /// foobar would be acceptable, too. (Note - this ...
- 3,152
6
votes
3
answers
2k
views
How to auto linewrap comments in .NET?
I'd like to have a single command to auto-linewrap the XML-style comments in .NET.
Example:
/// <summary>
/// This comment line should be
/// on one line, and other lines in this <summary&...
- 81k
1
vote
1
answer
104
views
How to get muli-language (human language) intellisense in .Net
I'm creating a library (C#, .Net), but I need to distribute it to customers in multiple countries. When you add XML comments to your classes, intellisense picks up the comments out of the assembly ...
- 2,569
2
votes
2
answers
645
views
Comment template in VS2010
I have inherited an API which doesn't have proper comments, and I am working on changing that.
Anyone know if there is some sort of mechanism to add a default XML comments to all the members of a ...
- 9,804
9
votes
1
answer
4k
views
How to specify language in xml comment <code> tag
Is there a way to specify what language is being used in the <code> tag used within an <example> tag in XML comments?
I am using Sandcastle Help File Builder to test building ...
- 5,597
5
votes
3
answers
2k
views
XML Comments - MSDN Documentation "Note" section -- how do you duplicate this?
Basically, in the MSDN online help I often run into a "NOTE" section, but cannot for the life of me figure out how to get that same output. Apparently there is no <note> tag. Does anyone know ...
- 32.6k
3
votes
1
answer
174
views
External comments are included in the reverse order, .Net Visual Studio
ETA: Visual Studio 2010 VB Express edition exhibits the same behaviour.
ETA: Visual Studio 2010 C# Express edition does NOT exhibit the same behaviour.
In VisualStudio 2008 VB Express edition, I ...
- 4,349
12
votes
3
answers
15k
views
Visual Studio - Summary Tag Comments - Optional Params
When specifying summary tag comments, is there a way with the <param> tag to note that a parameter is optional, ie. the client can supply a value or null, such as: <param name="Mime" ...
- 11.8k
1
vote
1
answer
1k
views
How to use <include> in external comments.xml file to refer to another member. .Net
I know how to use the <include> keyword from my code to refer to a member in an external comments file. Something like:
<include file="Comments.xml" path="Docs/ClassName/Members[@name='DoIt']...
- 4,349
15
votes
2
answers
5k
views
Multiline XML Comments in VB.NET and Visual Studio Intellisense
I'm trying to put newlines in my XML Comments in VB.Net. I've read two other posts about C#,
XML multiline comments in C# - what am I doing wrong?
Adding line breaks to comments for Intellisense
...
- 4,340
5
votes
4
answers
2k
views
How to see full document generated by xml-comments
I have writen a method such as:
/// <summary>
/// A method having xml-comments
/// This comment could be very long
/// </summary>
/// <param name="input">Input parameter</param&...
- 1,997
0
votes
1
answer
54
views
Is it possible to make VS specify the kind of type when building xml-comments?
I'm trying to create documentation for my code and I'm using xml-comments for it. When a class is documented like the following:
/// <summary>
/// Main presentation window
/// </summary>
...
- 1,350
4
votes
1
answer
384
views
Is it possible to put all the xml-comments of a solution into one xml-file?
I have a Visual Studio C# solution with 3 different projects in it. In each of the projects I've commented all the code using xml-comments. If I want the comments build into xml, I have to specify a ...
- 1,350
3
votes
2
answers
450
views
Closed generics in .NET XML comments
If i have the following function:
void ReadData(Action<DataContext> action) {}
how can i reference it in seealso construct?
<seealso cref="ReadData(Action<DataContext>)"/>
...
- 15.3k
6
votes
2
answers
2k
views
XML Comments - How do you reference a dictionary indexer properly?
As the name states, I have no idea how to reference a dictionary indexer. Any help here? :)
FYI, I've tried:
<see cref="Item"/>
<see cref="Item(Int32)"/> //Highly doubted this would work....
- 32.6k
1
vote
2
answers
329
views
MS Sandcastle - Is there any quick way to "preview" what the output will be without recompiling the entire help?
Well, the title asks it all.
I have the Sandcastle Help File Builder GUI. I can generate help files, but I was wondering if there was a faster way of seeing the results aside from recompiling the ...
- 32.6k
1
vote
2
answers
360
views
XML Comments in source code for derived classes or interface implementations
Related to my previous question. If I define an interface I'll comment its members. I then don't comment the implementing class's implementation unless there is a reason the original comment is no ...
- 4,919
1
vote
2
answers
158
views
Stop VB from showing xml comment preview
When you create an XML comment in C# and collapse it you only see:
<Summary>...
But in VB you could potentially see
Initializes the fubble to the watzer. This is actually the second line.
...
- 6,215
4
votes
3
answers
10k
views
XmlDocument reading XML Document comment Issue
I am using XmlDocument to parse xml file, but it seems that XmlDocument is always reading xml comments as a xml nodes:
My C# code
XmlDocument xml = new XmlDocument();
xml.Load(filename);
foreach (...
- 18k
9
votes
1
answer
2k
views
XML Comments - How to comment multiple reasons for an exception?
Here's an example:
public void DoSomething(String param1, String param2)
{
if (param1 == null) throw new ArgumentNullException("param1");
if (param2 == null) throw new ArgumentNullException("...
- 32.6k
1
vote
0
answers
208
views
The XML comments for methods appears in .wsdl file but not in WCF client side code [duplicate]
Possible Duplicate:
XML Comments not appearing in WCF Service
Thanks to WCFExtras, the XML comments for WCF methods appears in generated .wsdl file. Now the problem is that the XML comments doesn'...
- 185
0
votes
3
answers
289
views
In C#, is there a way to access xml comments (the tags in VS) in the source code at runtime?
In Visual Studio, xml comments can be added to methods/classes to provide documentation.
See http://msdn.microsoft.com/en-us/magazine/cc302121.aspx.
Visual Studio generates files from these xml ...
- 620
2
votes
2
answers
927
views
Documenting an array of type T in vsdoc format for javascript, Did I Find a Bug?
Following these guidelines for vsdoc documentation, I've been unable to get intellisense to work properly for an array of a given type. Here is some code that demos the problem
function MyType() {
...
- 19.5k
1
vote
1
answer
657
views
Force Visual C++ to generate XML comments solely for my files?
having an issue that I can't seem to find a direct answer to. I'm in the late stages of building a game engine with a few friends and at this point, we're looking to streamline the comments to make ...
- 431
1
vote
0
answers
888
views
XML Commenting - ambiguous reference "NotifyCollectionChangedEventArgs" in see cref tag?
Basically, I have the following: <see cref="NotifyCollectionChangedEventArgs"/> see tag in my XML Comments. ReSharper states that it is an ambiguous reference and suggests for me to give it as ...
- 15.4k
3
votes
0
answers
185
views
XML Commenting -- How to seealso to the method overload page? [duplicate]
Possible Duplicate:
How to make a cref to method overloads in a <seealso> tag in C#?
How can I XML comment my code so that I point to something like this instead of each individual method? ...
- 15.4k
6
votes
2
answers
943
views
XML Comments -- How (or where) do you create XML comments for your namespaces and library?
I understand that if you /// above a class, field, method, or property Visual Studio will start establishing XML-style comments for you.
However, where can I go to add XML comments for my namespaces ...
- 15.4k
7
votes
2
answers
1k
views
XML Comments -- How do you comment explicitly implemented interfaces properly?
Code:
public interface IFoo
{
void Bar();
}
public class FooClass : IFoo
{
/// <summary> ... </summary>
/// <seealso cref="?"/> //How do you reference the IFoo.Bar() ...
- 32.6k
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 ...
- 32.6k
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 ...
- 32.6k
4
votes
1
answer
239
views
XML Commenting -- How to properly mark a see also tag?
I have the following and I'm not sure how to properly reference this in my XML commenting:
public static class FooExtensions
{
public static Nullable<T> FooX<T>(this Nullable<T> ...
- 15.4k
14
votes
3
answers
7k
views
Should you write XML comments for Interfaces, concrete implementations, or both? [closed]
I am interested in where I should apply my XML comments. Should I put a more generic XML comment in the interface and a more descriptive one on the implementing class? Like this:
public interface ...
- 59.4k