How to add comments to C# or VB.NET code so that they reverse engineer in Rational XDE model?

Technote (troubleshooting)


Problem(Abstract)

How to add comments to C# or VB.NET code so that they reverse engineer in Rational XDE model?

Resolving the problem

QUESTION:

WINDOWS: How to add comments to C# or VB.NET code so that they reverse engineer in Rational XDE model?

ANSWER:

In C# :

1. Start typing three forward slashes immediately above the class, operation or attribute declaration.
VS.NET will automatically generate the following format:
/// <summary>
///
/// </summary>
2. Add your comment in the line sandwiched between opening and closing <summary> tag.
3. Save the source file.
4. Select the class in Model Explorer, and choose Synchronize command from the context menu.
5. When the class is selected in Model Explorer, the class comment appears in Model Documentation window. (Note: If Model Documentation is not currently available, go to View > Other Window > Model Documentation or use Ctrol+Shift+D keystroke).
When an attribute or an operation is selected in Model Explorer, a respective comment will appear in Model Documentation window.

Comments that do not comply with /// <summary> format, as well as comments inside the operation body will not appear in Model Documentation on reverse engineering.

In VB.NET:

Documentation that is preceded by a single quote (e.g. ' my comment goes here) and placed immediately above a class, operation or an attribute will appear in Model Documentation window. Comments inside the operation body will not appear in Model Documentation.

Historical Number

142086089

Rate this page:

(0 users)Average rating

Add comments

Document information


More support for:

Rational XDE .NET

Software version:

2002.05.20.516.009

Operating system(s):

All Windows Platforms

Reference #:

1130969

Modified date:

2010-10-27

Translate my page

Machine Translation

Content navigation