473,396 Members | 2,014 Online
Bytes | Software Development & Data Engineering Community
Post Job

Home Posts Topics Members FAQ

Join Bytes to post your question to a community of 473,396 software developers and data experts.

XML documentation comment question.

How do you reference a class constructor in a <see> or <seealso> tag?

using System;
namespace MyNamespace
{
/// <summary>
/// Does some stuff on some stuff.
/// </summary>
/// <remarks>
/// See <see cref="!!!HELP!!! WHAT DO I PUT HERE?!?!?!"/> for an example.
/// </remarks>
public class MyClass
{
/// <summary>
/// Creates an instance of <see cref="MyClass"/>.
/// </summary>
/// <example>
/// <code>
/// MyClass oClass = new MyClass();
/// </code>
/// </example>
public MyClass()
{
}
}
}

Nov 17 '05 #1
2 991
Have you tried the class name with parentheses after it?

<see cref="MyClass()"/>

I know that you can distinguish between method overloads this way:

<see cref="MyMethod()"/>

versus

<see cref="MyMethod(string)"/>

I imagine that constructors can be referenced the same way.

Nov 17 '05 #2
That worked. Thanks.

"Bruce Wood" wrote:
Have you tried the class name with parentheses after it?

<see cref="MyClass()"/>

I know that you can distinguish between method overloads this way:

<see cref="MyMethod()"/>

versus

<see cref="MyMethod(string)"/>

I imagine that constructors can be referenced the same way.

Nov 17 '05 #3

This thread has been closed and replies have been disabled. Please start a new discussion.

Similar topics

12
by: Fredrik Olsson | last post by:
Hello. For Java there is javadac, for Obj-C headerdoc2html, for C doxygen, and even for good old VB 6 there is VBDox. But I have found no suitable tool for documenting my .net code to get...
1
by: Ole Hanson | last post by:
I would like to be able to generate documentation for a custom configuration file (xml) to enable future support engineers to understand applicable values to the various elements inside the...
2
by: Sagar | last post by:
Hi Friends, Please forgive me if this question has appeared before. If so please give me a link or some clue on this problem. I'm writing XML comments to build Comment Web Pages by using...
5
by: Bikhod | last post by:
Hi Refering to my sample below, can anyone please tell me why my list is not appearing correctly on my VS.NET generated web site? The summary and remarks are fine, but the HTML is showing the...
97
by: Cameron Laird | last post by:
QOTW: "Python makes it easy to implement algorithms." - casevh "Most of the discussion of immutables here seems to be caused by newcomers wanting to copy an idiom from another language which...
40
by: GTi | last post by:
Is there any source code documentation tools available for Visual Studio 2005 ? I have created a LIB that must be documented. Must I do it by hand or is it some kind of tools to pre document my...
2
by: Tim_Mac | last post by:
hi, i have VS2005 professional, and i would like to generate a complete documentation reference for all the classes in my web project. i would have thought this was as simple as a button or build...
10
by: Lloyd Dupont | last post by:
Let say I have 2 methods: void BeginGroup(); void BeginGroup(string msg); when I want to refer to them I write /// <see cref="BeginGroup"/> But this cause a compiler warning, where my...
5
by: Bob Altman | last post by:
I thought I read somewhere in the MS documentation that XML documentation is compiled in C++, but the C++ code editor obviously doesn't do anything interesting when I enter "///". What's the deal...
0
by: Charles Arthur | last post by:
How do i turn on java script on a villaon, callus and itel keypad mobile phone
0
by: ryjfgjl | last post by:
In our work, we often receive Excel tables with data in the same format. If we want to analyze these data, it can be difficult to analyze them because the data is spread across multiple Excel files...
0
by: emmanuelkatto | last post by:
Hi All, I am Emmanuel katto from Uganda. I want to ask what challenges you've faced while migrating a website to cloud. Please let me know. Thanks! Emmanuel
0
by: Hystou | last post by:
There are some requirements for setting up RAID: 1. The motherboard and BIOS support RAID configuration. 2. The motherboard has 2 or more available SATA protocol SSD/HDD slots (including MSATA, M.2...
0
marktang
by: marktang | last post by:
ONU (Optical Network Unit) is one of the key components for providing high-speed Internet services. Its primary function is to act as an endpoint device located at the user's premises. However,...
0
by: Hystou | last post by:
Most computers default to English, but sometimes we require a different language, especially when relocating. Forgot to request a specific language before your computer shipped? No problem! You can...
0
by: Hystou | last post by:
Overview: Windows 11 and 10 have less user interface control over operating system update behaviour than previous versions of Windows. In Windows 11 and 10, there is no way to turn off the Windows...
0
tracyyun
by: tracyyun | last post by:
Dear forum friends, With the development of smart home technology, a variety of wireless communication protocols have appeared on the market, such as Zigbee, Z-Wave, Wi-Fi, Bluetooth, etc. Each...
0
agi2029
by: agi2029 | last post by:
Let's talk about the concept of autonomous AI software engineers and no-code agents. These AIs are designed to manage the entire lifecycle of a software development project—planning, coding, testing,...

By using Bytes.com and it's services, you agree to our Privacy Policy and Terms of Use.

To disable or enable advertisements and analytics tracking please visit the manage ads & tracking page.