Book a Demo

Author Topic: Function parameters and comments.  (Read 2697 times)

turn2

  • EA Novice
  • *
  • Posts: 4
  • Karma: +0/-0
    • View Profile
Function parameters and comments.
« on: August 11, 2005, 08:04:49 am »
Hi,
When reverse engineering, I'm wondering where function parameter comments should be in the code such they show in the Parameters Tab of the Properties for that operation. They would then be carried into documentation as well...
Thanks for any help in this matter.

Eve

  • EA Administrator
  • EA Guru
  • *****
  • Posts: 8110
  • Karma: +119/-20
    • View Profile
Re: Function parameters and comments.
« Reply #1 on: August 11, 2005, 03:31:14 pm »
You can either use a formatted operation comment (.net xml style comments or javadoc comments, depending on the language you are using.) or put them immediately before each parameter.

(The second option is currently not available for C++, Delphi, VB and VB.Net)

Simon

turn2

  • EA Novice
  • *
  • Posts: 4
  • Karma: +0/-0
    • View Profile
Re: Function parameters and comments.
« Reply #2 on: August 15, 2005, 12:24:38 pm »
Thanks.
Im in the .NET IDE, so XML style works.

Is there somewhere in the documentation indicating which tags are supported? (I tried the <returns> tag and it doesn't really fit...)