Click here to Skip to main content
15,923,789 members
Home / Discussions / C#
   

C#

 
GeneralRe: Build an enterprise application for a customer with aprox. 100 Clients ??? Pin
gicio18-Mar-04 23:45
gicio18-Mar-04 23:45 
Generalregd datagrid and control boxes Pin
karteek17-Mar-04 5:20
karteek17-Mar-04 5:20 
GeneralUsing an unmanaged C++ dll in C# Pin
granderson17-Mar-04 4:55
granderson17-Mar-04 4:55 
GeneralRe: Using an unmanaged C++ dll in C# Pin
Heath Stewart17-Mar-04 5:15
protectorHeath Stewart17-Mar-04 5:15 
GeneralRe: Using an unmanaged C++ dll in C# Pin
Jeremy Kimball17-Mar-04 7:42
Jeremy Kimball17-Mar-04 7:42 
QuestionHow do you add intellisence text to an object or function? Pin
Manster17-Mar-04 4:28
Manster17-Mar-04 4:28 
AnswerRe: How do you add intellisence text to an object or function? Pin
Colin Angus Mackay17-Mar-04 5:24
Colin Angus Mackay17-Mar-04 5:24 
AnswerRe: How do you add intellisence text to an object or function? Pin
Heath Stewart17-Mar-04 5:25
protectorHeath Stewart17-Mar-04 5:25 
You must document your source (or go through the pain-staking process of writing an XML document that conforms to the standards, which is difficult and your source should be documented anyway) and generate an XML document from it. For instance, do something like this:
/// <summary>This class does X.</summary>
/// <remarks>A better, longer description...</remarks>
public class MyClass
{
  /// <summary>
  /// Creates a new instance of the <see cref="MyClass"/> class.
  /// </summary>
  public MyClass()
  {
  }
  /// <summary>Returns <paramref name="param1"/> + 1.</summary>
  /// <param name="param1">Description of param1</param>
  /// <returns>An <see cref="Int32"/> that represents something.
  public int SomeMethod(int param1)
  {
    return param1 + 1;
  }
}
In VS.NET, right-click on your project and select Properties. Set the configuration to "All Configurations" (recommended) and find the Configuration Properties/Build section. Specify a name in the "XML Documentation File". If you don't specify a path (so just a filename), the filename is written to the build directory (like bin\Debug or bin\Release depending on the build configuration at the time of compiling). This is the same as the /doc option for the csc.exe command-line compiler.

See Recommended Tags for Documentation Comments[^] for more information. You can use any tags, but you should at least use these (like many documentation compilers like NDoc[^] that I help with will also recognize <b> tags, <p> tags, etc.).

When you deploy your assembly, make sure the generated XML document has the SAME name as the assembly, only that is has a .xml extension instead of .dll. VS.NET (and other editors of any decent value) will query for this file and use it to display comments for your assembly in the source editor.

 

Microsoft MVP, Visual C#
My Articles
Generalusing a modem in c#. Pin
youssef17-Mar-04 4:23
youssef17-Mar-04 4:23 
GeneralRe: using a modem in c#. Pin
Dave Kreskowiak17-Mar-04 9:04
mveDave Kreskowiak17-Mar-04 9:04 
GeneralRe: using a modem in c#. Pin
Anonymous17-Mar-04 16:15
Anonymous17-Mar-04 16:15 
GeneralC# Web Service and Soap Exceptions Pin
Chris Meech17-Mar-04 3:55
Chris Meech17-Mar-04 3:55 
GeneralRe: C# Web Service and Soap Exceptions Pin
Heath Stewart17-Mar-04 5:58
protectorHeath Stewart17-Mar-04 5:58 
GeneralRe: C# Web Service and Soap Exceptions Pin
Chris Meech17-Mar-04 7:02
Chris Meech17-Mar-04 7:02 
GeneralParameter Xml Pin
bertcox17-Mar-04 3:18
bertcox17-Mar-04 3:18 
GeneralRe: Parameter Xml Pin
Not Active17-Mar-04 4:15
mentorNot Active17-Mar-04 4:15 
QuestionMarshaling c LARGE_INTEGER (ulong, ulong)? Pin
Tristan Rhodes17-Mar-04 2:16
Tristan Rhodes17-Mar-04 2:16 
AnswerRe: Marshaling c LARGE_INTEGER (ulong, ulong)? Pin
Heath Stewart17-Mar-04 5:54
protectorHeath Stewart17-Mar-04 5:54 
GeneralOpen MDI Child form from already MDI child form Pin
Inpreet Singh17-Mar-04 1:36
Inpreet Singh17-Mar-04 1:36 
GeneralRe: Open MDI Child form from already MDI child form Pin
Heath Stewart17-Mar-04 5:53
protectorHeath Stewart17-Mar-04 5:53 
GeneralRe: Open MDI Child form from already MDI child form Pin
Dave Kreskowiak17-Mar-04 5:59
mveDave Kreskowiak17-Mar-04 5:59 
GeneralRe: Open MDI Child form from already MDI child form Pin
surgeproof17-Mar-04 6:21
surgeproof17-Mar-04 6:21 
QuestionHow to resize column width of datagrid. Pin
Inpreet Singh17-Mar-04 0:49
Inpreet Singh17-Mar-04 0:49 
AnswerRe: How to resize column width of datagrid. Pin
Mazdak17-Mar-04 3:29
Mazdak17-Mar-04 3:29 
AnswerRe: How to resize column width of datagrid. Pin
Heath Stewart17-Mar-04 5:47
protectorHeath Stewart17-Mar-04 5:47 

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Praise Praise    Rant Rant    Admin Admin   

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.