313 questions
1
vote
0
answers
298
views
How can I configure doxygen to generate html with plain list of files?
I have a project with tree like structure written in C#. I need to list all *.cs files in plain list with comments.
For example:
MyProject
Models
Model1.cs
Model2.cs
Controllers
Controller1.cs
...
- 49
1
vote
2
answers
892
views
How to include dependent projects XML-comment files during a publish?
When I use the "normal" "Publish-tool" built into Visual Studio for ASP.net, it seems like it does not include XML-comment-files that belongs to dependent projects/assemblies.
For instance, lets say ...
- 2,139
0
votes
0
answers
199
views
Documenting members of members in C# XML-Comments
How do you document members of members in C# XML-Comments with the <see cref=".." tag?
I'm trying to document them the same way as type members, but it's giving me the warning "XML comment has ...
- 768
1
vote
1
answer
235
views
Wrong comment alignment in xml files
I'm using copyright comment at the beginning of every file but there is an annoying issue with xml files in Android Studio.
Using automatic code format option (CTRL+ALT+L) places comment on the first ...
- 992
0
votes
1
answer
55
views
Create a XML from SQL Server
I need some help. I'm trying to create an XML with this query:
WITH XMLNAMESPACES ('Envelope' AS soapenv)
SELECT *
FROM CrearViaje4
JOIN transporte ON CrearViaje4.Cod_viaje = transporte....
1
vote
0
answers
77
views
XML Documentation Navigation for C++ in Visual Studio (as in C#)
There is XML Documentation support for Visual C++ with IntelliSense and all for some time now.
Navigation from XML documentation, peek help etc. does not work though. Coming from C#, I dearly miss ...
- 245
2
votes
1
answer
200
views
How do I reference a constructor in an XML comment in Visual Basic?
Let's say I have the following code:
Public Sub New(num As Integer)
End Sub
''' <summary>
''' <see cref=""/>
''' </summary>
Public Sub DoSomething()
End Sub
What do I put between ...
- 2,120
4
votes
1
answer
2k
views
How to show content inside see cref in XML comment from Intellisense and DocFx?
I have used XML comment on a property which is a type of List.
However when I hover my mouse to that property, Visual Studio shows it as List<T>.
When I build the documentation with docFx, it ...
- 1,288
0
votes
1
answer
599
views
How does xml comments work between projects in one solution
I'm setting up xml comments through properties in project in solution. I want this comments to be seen in other project in same solution. However project and xml being refereenced in bin near .exe isn'...
- 441
1
vote
1
answer
2k
views
Swagger XML comments file - missing comments
I'm self-hosting Swagger documentation for my Web API 2 API with Swashbuckle.Core 5.6.0
I'm enabling Swagger in my Startup.cs as follows
config.EnableSwagger(c =>
{
c....
- 1,285
2
votes
1
answer
158
views
Change xml description of property in derived class
Is there a way to change the xml description of a property in a derived class without rewriting getter and setter declaration?
Example:
public abstract class BaseClass
{
/// <summary>
///...
- 592
0
votes
0
answers
199
views
How to create an XML root/prolog comment using PowerShell?
I'm trying to add a root comment to an XML file that doesn't have one. I'm close, but can't get it in the root/prolog area and instead can only get it injected after the first element.
(preloading [...
- 1
1
vote
0
answers
116
views
Removing processing instructions and comments that appear before the root of a document without copying the whole tree?
With lxml's API it's possible to access preliminary elements before the root such as processing instructions and comments by querying the sibling (and its siblings in turn) of the root element:
>&...
- 4,057
15
votes
1
answer
2k
views
Alternative to XML Documentation Comments in C#
When asking around for the conventions of documentation comments in C# code, the answer always leads to using XML comments. Microsoft recommends this approach themselves aswell. https://learn....
user8190030
4
votes
1
answer
347
views
XML Comments stored inside external file is not showed by Intellisense
I followed this MSDN guide for commenting my code.
I discovered i can use external files to achieve the same result in a more clean way.
However, my IntelliSense don't show those comments on Visual ...
- 41
0
votes
1
answer
929
views
Is there a way to put formatted maths into XML commenting C# Visual Studio?
I want to be able to put a formatted mathematic equation into my XML comments, is there a plugin to allow me to do this or maybe some other way?
I am currently using this:
/// <summary>
/// e^-...
user10124074
6
votes
1
answer
994
views
Visual Studio 2017: <list> not showing correctly on hover (xml documentation)
If you hover over something (class, method,...) that's got xml documentation (///<summary></summary>) in VS17 (15.6.2), you get this little popup that shows the comments properly formatted....
- 2,013
2
votes
1
answer
784
views
Generic class comment to display the type of T used xml commenting
I have generic class
public class Range<T> where T : IEquatable<T>
{
///<summary>
/// Minimum value of Range<T>
///</summary>
public T Min;
}
and if I ...
user3915050
0
votes
0
answers
83
views
What do brackets mean in C# xml documentation generated by ghost doc?
I generated xml-comments to a method with Ghost doc
/// <summary>
/// Determines whether [is lv class identifier] [the specified class identifier].
/// </summary>
/// <...
- 8,386
0
votes
0
answers
168
views
Ignoring comments with StaX
Using the following code, I'm successfully reading XML files. However when a comment appears in the middle of a node, the reader is discarding the remainder of the node. For example:
<text>...
- 57
17
votes
2
answers
25k
views
c# xml comment, cref can't reference method defined in base class
In my codebase I have a method defined in a base class, the base class is inherited, but the method is not yet overridden. This method will very likely be overridden in the future to add to the base ...
- 2,676
0
votes
3
answers
745
views
Sandcastle not generating params or return
I have a Visual Studio C# project with XML documentation comments. I get a .xml file with <summary>, <param>, <returns> and <example> members.
The text I put inbetween the <...
- 125
0
votes
0
answers
44
views
Describe generic of generic in XML documentations
In my interface I have the following method signature:
ServiceResponse<IDictionary<int, string>> Dictionary(DictionaryRequest request);
I'm trying to add XML comment for that method like:
...
- 1,309
0
votes
1
answer
1k
views
GhostDoc "Document this" not working for method with attribute
I am using GhostDoc and Visual Studio 2017.
Now, if I have a method like this
public string Foo() { ... }
I can normally use GhostDocs "Document this" to generate an XML comment for the relevant ...
- 5,155
1
vote
0
answers
503
views
Reference to dependent assembly in XML Comments
I have 2 class libraries projects A and B, and A depends on (has a reference to) B.
In B I have a class to which I want to add XML comments, and mention a class in A using a <see cref="ClassInA"/&...
- 1,698
1
vote
3
answers
85
views
Why shouldn't XML comments contain hidden commands?
I'm reading Core Java vol. 2 by Cay Horstmann, and in the chapter about XML where he talks about XML comments he says:
Comments should only be information for human readers. They should
never ...
- 1
12
votes
3
answers
11k
views
Use property XML comments as parameter descriptions in Swagger
I created a Web API using ASP.NET Core and used swagger to create documentation. I use the XML comments on my API endpoints to provide additional information in the documentation. The swagger ...
- 1,454
4
votes
2
answers
2k
views
Hide XML comments in Visual Studio 2017 (version 15.5.1)
When collapsing the XML comments for methods etc. It used to be that the summary was hidden. As I would like it to be. Then in VS2015 they broke this. I asked a similar question about VS2015 and got a ...
- 28k
0
votes
0
answers
287
views
Uncommenting in a .xml file with Powershell [duplicate]
I'm writing a script that replaces and delete some commented lines but the problem is the .xml file got more than only one thing which is commented and I only have to uncomment one of these. It would ...
0
votes
1
answer
2k
views
comment and uncomment xml elements with python
I would like to comment and un-comment, selected element in XML.
xml looks like this.
<ls>
<lo n="x" add="b" l="D">
<myconf conf="rf"/>
<!-- <myconf ...
- 887
1
vote
1
answer
1k
views
Class Library with all Models not getting Xml Comments for Swagger
I have a common class library that is packaged as it's own nugget library.
it's nuspec looks like the following xml:
<?xml version="1.0"?>
<package xmlns="http://schemas.microsoft.com/...
- 6,374
0
votes
0
answers
120
views
Publish Action NOT including class libraries comments.xml files
I have a solution that has two projects, and a nuget package:
- WebApp.csproj
- CommonClassLibrary.csproj
- nugetClassLibrary.nuget
The WebApp has a project reference to CommonClassLibrary.csproj, ...
- 6,374
0
votes
1
answer
1k
views
Add comments in JAXB output?
I would like to add some comments to an XML file produced via JAXB, but as far as I can tell, this doesn't seem to be possible. The file that I'm producing is expected to be hand modified by humans ...
- 994
1
vote
2
answers
267
views
How to add XML documentation comments to Xamarin iOS Bindings Library?
I am implementing Xamarin iOS Bindings Library to bind an Objective-C framework.
I would like it to contain XML documentation comments if it's even possible.
Is there any way to grab them from ...
- 2,260
0
votes
1
answer
2k
views
Writing comments in metadata
So I did some searching on google but did not find the answer or maybe did not understand the answer?
I would like to write some comments into my code so even after release it will be still visible ...
- 183
9
votes
3
answers
4k
views
EPPLUS adding comment results error opening excel file
I would like to add comments at one cell, So.. I did:
...
ExcelPackage package = new ExcelPackage(new MemoryStream());
var ws = package.WorkBook.WorkSheet[1];
ws.Cells[1, 1].AddComment("Lot ...
- 171
7
votes
1
answer
1k
views
What is the "T:" for when used in a cref
What does the T: part mean in the use of the cref attribute here?
<see cref="T:System.Windows.Form.Control"/>
and
<see cref="System.Windows.Form.Control"/>
- 586
4
votes
4
answers
6k
views
Visual Studio XML summaries not working
When I used to use Visual Studio I could use /// to declare a summary of my method at the and it would autogenerate all the tags and add a line for any params however after installing Visual Studio ...
- 163
0
votes
0
answers
1k
views
In Swagger ASP.NET Core Production Environment, how to keep metadata from XML Comments?
From the Ahoy repository's examples (see the README), in the basic example, they do use XML Comments to generate some metadata for Swagger to serve up. However, they only configure it if the app is in ...
- 2,491
5
votes
0
answers
359
views
Is it possible to set the width of tooltips in Visual Studio Code Editor windows?
For just about all languages I program in, I am often annoyed by the width of the tooltips caused by XML auto-documentation comments. In some cases I started prepending each line with a <para />,...
- 57.5k
0
votes
1
answer
833
views
JDom How to comment an existing line
I am currently struggling to comment an existing line with JDom, best I would like to comment an entire node.
SAXBuilder jdomBuild = new SAXBuilder();
jdomDoc = jdomBuild.build(fileLocation);
...
- 158
0
votes
1
answer
61
views
Visual Studio: Doc Comments that get updated when renaming classes/fields/methods
I have a class (written in C#) with some documentation comments:
/// <summary>
/// Abstract class defining a tolerance-based method for Equals.
/// Tolerance must be defined in a derived class ...
- 2,956
3
votes
2
answers
835
views
Where is the snippet for a method's XML summary?
I'm referring to the snippet that's used when typing /// before a method.
I've found something for JavaScript (C:\Program Files (x86)\Microsoft Visual Studio 14.0\JavaScript\Snippets\1033\XML ...
- 28k
23
votes
5
answers
15k
views
What is the purpose of remarks tag in c#
I understand that remarks tag is used to provide additional information about the class but it is not displayed in intellisense while hovering / calling that class. I would like to know Where exactly ...
0
votes
0
answers
33
views
Does eclipse support xml comment description like Visual Studio?
I'm trying to switch a project from Visual Studio to Eclipse. In Visual Studio you could comment functions and parameters with xml comments. These comments where then shown in the code completion.
///...
- 11
2
votes
1
answer
204
views
Sandcastle multiple code examples in one tab control
I'm having trouble using the code examples within sandcastle. I want to be able to have four examples in one tab control however I am unsure how to do this.
/// <summary>
/// AnimatedExpander ...
- 590
0
votes
0
answers
81
views
How do I get the name used in the XML documentation for a .Net Type
I have an API project that uses .Net's XML documentation. This results in MyApp.dll getting a MyApp.xml file with all the code comments, which looks something like this:
<?xml version="1.0"?>
&...
- 157k
5
votes
4
answers
23k
views
How to comment strings of code in SOAP UI editor?
How to comment out strings of code in SOAP UI editor using shortkeys?
I have SOAP UI 5.2.1.
- 1,329
0
votes
1
answer
134
views
Process custom xml elements in xml document code comments for MSDN style Help files
I am looking for a way to build Help files that include custom XML elements for a large project. I want to add my own element similar to the Summary element and have the help files include it. I have ...
- 2,867
2
votes
1
answer
352
views
Can portions of the Func<T1,T2,....> parameter be given xml comments for intellisense?
So, I have a an action that takes a callback and performs it. It looks a little bit like this. Is there anything I can fill in into the question mark area (or elsewhere) to document the details of the ...
- 730