Skip to main content
313 questions
Newest Active Bountied Unanswered
Filter by
Sorted by
Tagged with
0 votes
6 answers
4k views

I am learning Android and want to be able to add line comments to my XML so I can remind myself what things are doing. Is there an accepted practice for this, or is it possible in Android Studio? I ...
AJJ's user avatar
  • 2,084
12 votes
3 answers
2k views

Is it me or are the XML comments missing for System.Linq in Visual Studio 2015? Because I can still find it on MSDN. But when typing, for example, this code: var list = new List<string>(); list....
QuantumHive's user avatar
  • 5,693
0 votes
0 answers
1k views

In Unity Monodevelop C#, how do I add a "comment" line top & bottom, so that it auto-generates as part of the XML documentation auto-completion? Currently, when /// is pressed above the class/...
user3477955's user avatar
  • 91
90 votes
3 answers
43k views

In MonoDevelop, when I type "///", it auto-generates an xml-style comment like this: /// <summary> /// Describes the variable x /// </summary> int x = 0; Is there a way to get this ...
s2Jakob's user avatar
  • 901
7 votes
1 answer
4k views

I have a method that throws an exception under the namespace: MyApp.Domain. I have some of my custom exceptions under the namespace: MyApp.Domain.Exceptions. So what I have is this: using MyApp.Domain....
interesting-name-here's user avatar
  • 1,890
0 votes
1 answer
863 views

I'm very disciplined in writing detailed summaries of interfaces, classes, properties and methods. It's while I have in focus to share my code to anyone beeing able to read without any expenses in ...
codekandis's user avatar
  • 827
1 vote
0 answers
724 views

I am having trouble with an xml comment on a web api controller method. I have a class with several properties as a parameter on this method. When I want to add a description to the properties ...
Spaceman Spiffed's user avatar
  • 11
1 vote
0 answers
327 views

I recognized two issues in commenting (XML style) Visual C++/CLI generic functions. Typed functions behave as expected. System configuration is Windows 7 and Visual Studio Premium 2013. The project ...
Christian St.'s user avatar
  • 1,951
3 votes
0 answers
255 views

Since Visual Studio 2005 we could copy a file named VBXMLDoc.xml into the path: C:\Users\*user*\AppData\Roaming\Microsoft\VisualStudio\*version*\ to define the XML tags available for documentation, ...
Wilhelm's user avatar
  • 1,926
0 votes
0 answers
173 views

When commenting my code, I know that I can link to a webpage like this: /// <Refer url="http://microsoft.com/foo/bar.aspx"/> But is it possible to reference an excel document (for example) on a ...
Quantum_Kernel's user avatar
  • 343
1 vote
1 answer
43 views

I use XML for configurations but sometimes I want to test new ones and use comments to leave them separated from the rest like this: <!-- Begin testing block comments --> <test1> ...
CMPSoares's user avatar
  • 4,205
1 vote
1 answer
169 views

I have my code documented with XML comments and am learning how to use SandCastle to generate html API help documentation. I'm going to publish that html documentation to an internal website. How ...
Sean B's user avatar
  • 11.7k
1 vote
1 answer
1k views

I read all questions about intellisense problems but my intellisense doesn't work. Visual Studio Ultimate 2013 I don't use any extension like Resharper, ghostdoc and so on All XML documentation files ...
Enrico Tirotta's user avatar
  • 323
0 votes
1 answer
521 views

I'm trying to write a <see cref> XML comment for the type byte[]. Unfortunately, the standard syntax: <see cref="T:System.Byte[]"> causes an error when executing the Remove and Sort ...
Teejay's user avatar
  • 7,551
20 votes
3 answers
8k views

I like to have clean, "0 warnings" - projects in C#. This includes my project having XML comments for every public property and class. Now I use entity framework with migrations (code first). The ...
Ole Albers's user avatar
  • 9,399
5 votes
0 answers
2k views

I have a generic abstract base class that has some methods on it. Those methods have XML Comments on them as such: /// <summary> /// Controller for working with instances of {TModel} /// &...
Jereme's user avatar
  • 1,485
5 votes
1 answer
5k views

I have some C# codes using doxygen comments for some equations. VS2013 should me a warning message warning CS1570: XML comment on 'myclass' has badly formed XML -- 'A name was started with an ...
Bangyou's user avatar
  • 9,876
2 votes
1 answer
278 views

I have an ASP.NET project which generates an XML documentation file. I'm using Swashbuckle and would like it to be able to reference the XML comments file while debugging. However, when I run the ...
Overlord Zurg's user avatar
  • 3,832
1 vote
1 answer
205 views

Is it possible to create a cref from c# codes to a file in a database project so you can ctrl + click to navigate to it like you can with .cs files? e.g. Say I have some data access code that uses a ...
jparram's user avatar
  • 804
1 vote
1 answer
530 views

I am trying to declutter my classes that contain a fair amount of code. I want to also document and document well. Unfortunately for me to do this all in one file creates chaos for the eyes personally....
David Carrigan's user avatar
  • 793
2 votes
0 answers
735 views

I'm trying to use C# XML comments in conjunction with conditional directive. With #if SYMBOL it works: /// <summary>Some summary.</summary> #if SYMBOL /// <remarks>...
Martin Vobr's user avatar
  • 5,843
5 votes
1 answer
283 views

Extracting comments out of C# class files is relatively easy (see Extracting doc comments from C# source file), but I've recently come into the opposite problem. My project has a bunch of classes ...
gcarvelli's user avatar
  • 1,580
76 votes
4 answers
33k views

Is it possible to comment one or several attributes inside an XML tag? Something like /* */ from C. I have tried using <!-- -->, but it was unsuccessful. <element attribute1="value1" ...
Ntropy Nameless's user avatar
  • 896
7 votes
1 answer
13k views

<!-- Comment --> is the way to add comments in an XML file. Doesn't that actually means, that this part is not "compiled"? However, when I do something like this: <item android:id="@+id/...
user3801167's user avatar
  • 177
14 votes
1 answer
3k views

In Visual Studio (2012+) I want a clickable reference from a code comment to a TFS work item. Is there a simple way to do this, and is this also possible from comments within the body of a function (...
Michel van Engelen's user avatar
  • 2,879
2 votes
2 answers
175 views

I have a XSD that has a number of comments, which should be moved into the a xs:annotation/xs:documentation part of the preceding xs:simpleTypes or xs:complexTypes. How can I move these comments using ...
Gunther Stuhec's user avatar
  • 25
1 vote
1 answer
145 views

I want to add a line in Sandcastle generated example code This is what i have written so far /// <summary> /// Represents the SQL Connection for interaction with the Database /// </summary&...
Pankaj's user avatar
  • 2,780
8 votes
3 answers
4k views

I'm writing a simple compare function with the following signature: /// <summary> /// Casts two unsigned integers to signed integers and compares them /// </summary> /// <param ...
audiFanatic's user avatar
  • 2,524
2 votes
1 answer
773 views

How can I write this in a proper way: /// <summary> /// Provides extension methods for <see cref="System.Collections.Generic.Dictionary"/> matrix. /// </summary> public static class ...
dajuric's user avatar
  • 2,547
2 votes
1 answer
86 views

CakePHP provides a functionality to generate XML documents/strings from an array (s. CakePHP docu -> Core Libraries -> Utilities -> Xml -> Transforming an array into a string of XML). Simple example: ...
automatix's user avatar
  • 15.2k
6 votes
1 answer
492 views

I am trying to get the best out of doxygen and IntelliSense, and found the XML commands to be a pretty good win here: documentation get generated on one hand, while it appears during completion on the ...
Julien Guertault's user avatar
  • 1,344
3 votes
0 answers
190 views

In an MVC 4 ASP.Net project I have the following JavaScript file: Foo = function () { ///<field name="bar" type="Foo" mayBeNull="true"></field> this.bar = null; } Foo.prototype....
Nico Schertler's user avatar
  • 32.7k
1 vote
0 answers
196 views

I would like specify in XML comments that method return collection of IEnumerable<FileInfo>. What is correct format for XML tag <returns/>. /// <summary> /// Extensions methods ...
jose's user avatar
  • 63
0 votes
1 answer
82 views

I created a .dll with xml commented functions and subs, like: ''' <summary> ''' Gets the Path of this assembly ''' </summary> ''' <returns>Assemblypath</returns&...
ruedi's user avatar
  • 5,615
9 votes
1 answer
1k views

What is the proper XML-comment syntax to refer to the SingleOrDefault extension method on the IEnumerable interface? My latest attempt is: <see cref="IEnumerable{T}.SingleOrDefault{T}()"/> The ...
harley.333's user avatar
  • 3,702
4 votes
1 answer
1k views

I'm having trouble getting the generic parameters for the two methods below to display the types in Intellisence. For the IEnumerable<T> I just simply want it to show as double. And for the ...
HodlDwon's user avatar
  • 1,171
0 votes
1 answer
172 views

I need to create cell comments for existing excel file by extracting the xlsx file and using raw XML file. Is it possible to do it in java without using Apache poi library?
Soorya Prakash's user avatar
  • 991
0 votes
2 answers
462 views

How do I correct specify the XML Comments for a 2D array of nullable doubles? The following gives me syntax error. /// <returns>The <see cref="double[,]"/>.</returns> public double?[...
openshac's user avatar
  • 5,193
0 votes
0 answers
94 views

I want warnings for bad XML comments. They're turned on in Project Options and there are no Compiler Directives inside the unit with the bad xml comments, but I'm not getting any warnings. What else ...
RSE's user avatar
  • 322
9 votes
1 answer
1k views

Using XML comments in C#, I can document that a method may throw an exception: <exception cref="FooException">Thrown if foo is invalid.</exception> However, if a method has no exception ...
Daniel Wolf's user avatar
  • 13.8k
10 votes
2 answers
2k views

I wonder how these XML references work, I'm just not getting why they work or why they don't work and I found nothing about that. Here's an example: type TOuterClass= class strict private ...
RSE's user avatar
  • 322
1 vote
2 answers
698 views

I would like to document my VB.NET web site's source code. How can I convert XML comments in a VB.NET ASP.NET web site to an XML documentation file? I do not see an option to generate an XML ...
ChandaMAMA's user avatar
  • 73
1 vote
1 answer
810 views

My question How do I write comments for my class methods in C++ using Microsoft Visual Studio 2010 and make them appear in the tooltip? Maybe it should work, but I do not see my comments appear in ...
Michiel Pater's user avatar
  • 23.2k
2 votes
2 answers
166 views

Is there a way (tool, or something) that permits do not duplicate the same XML comments when inheriting/Overriding methods from the base classes? Eg.: /// <summary> /// Represent a brand new ...
serge's user avatar
  • 15.4k
1 vote
2 answers
108 views

I have the following code block. /// <summary> /// AMethod produces this XML: /// <A><B></B></A> /// </summary> public void AMethod() { ...
Daniel Ball's user avatar
  • 1,673
2 votes
3 answers
2k views

I have the following problem with my EDMX file. In it I have written some Documentation for the properties as well as the Entities, but the t4 template of my EF 5 doesnt generate those values. My ...
Rand Random's user avatar
  • 7,477
2 votes
0 answers
1k views

I have the following class; [XmlRoot("Customer")] public class MyClass { [XmlElement("CustId")] public int Id {get;set;} [XmlElement("CustName")] public string Name {get;set;} } I ...
neildt's user avatar
  • 5,403
2 votes
1 answer
810 views

How do I publish the xml-comments with my assemblies in a NuGet Package so that consumers can see class / method comments?
Vincent-Philippe Lauzon's user avatar
  • 889
14 votes
5 answers
7k views

So I use XML Comments in my code to help explain Public Methods and Public Members, another developer has mentioned that not all of my methods have XML Comments. I use the rule, if public or protected,...
Rodders's user avatar
  • 2,425
7 votes
5 answers
1k views

I'm building application and one of requirements is to use a comments like this one: /// <summary> /// Creates new client. /// </summary> /// <param name="uri">The URI.</param>...
Roman Pushkin's user avatar
  • 6,201

1 2
3
4 5
…
7