Book a Demo

Author Topic: Using XML-style comments in reports  (Read 2284 times)

Jerkerus

  • EA Novice
  • *
  • Posts: 9
  • Karma: +0/-0
  • Think first - order later!
    • View Profile
Using XML-style comments in reports
« on: March 29, 2007, 04:14:20 am »
We synchronize VB.Net code with EA and then use EA to generate documentation (both HTML report and RFT documents).

It works well, except for the XML-style comments.

Code:
''' <summary>Description of the operation</summary>
''' <param name="inparameter">Description of parameters</param>
''' <returns>Return value</returns>
''' <remarks>Other remarks</remarks>
''' <exception>Exceptions thrown</exception>

Reversed engineered to EA the <summary> and <param> tags are fully supported. The other end up in the Notes section of the operation (as @remarks, @returns, @exception). This works well when changing the comments and re-generating the code. But in the generated documentation it ends up in the Notes section.

HTML doc
Notes: Description of the operation

@returns Return value
@remark Other remarks
@exception Exceptions thrown
 
Still with the @remarks-tag (etc) which does not look very good.

I would like to control where these tags end up, and strip the qualifier. Or at least the latter - replace the @remarks with my own label.

Anyone?

Thanks