Reverse engineering C code comments (C code)

Integrations (PTC products, 3rd party products and code) > Code integration (Ada, C, C#, C++, IDL, Java, SQL and VB) > C Code > Reverse engineering legacy C code > Concepts > Reverse engineering C code comments (C code)

The Reverser reverse engineers code comments.

Typically, the Reverser reverse engineers comments that precede and are on the same line as code elements. The comments are reverse engineered to the Description property of the item created for the code element.

For example, the code element for Class1 is prefixed by two comment lines. The two comment lines are reverse engineered to the Description property of the Class that is created in the Model.

Code	Modeler
//Description of Class1 line 1 //Description of Class1 line 2 class Class1 { };

Note that the Reverser uses white space to delimit preceding comments. For example, if in the preceding example there was white space between the two comment lines, only the second comment would be reverse engineered.

Code	Modeler
//Description of Class1 line 1 //Description of Class1 line 2 class Class1 { };

In the following example, the comment follows the code element for Attribute1. The comment is reverse engineered to the Description property of the Attribute that is created in the Model.

Code	Modeler
class Class1 { private: // private attributes char Attribute1; //Desc. of Attribute1 };