Author Topic: XML doc comments  (Read 3667 times)

CleverCoder

  • EA User
  • **
  • Posts: 34
  • Karma: +0/-0
    • View Profile
XML doc comments
« on: August 27, 2007, 06:38:13 am »
It would nice if we could have more formal support for XML doc comments. We use Sandcastle for documentation and one of the main reasons this product stands out is for it's ability to understand and create ///<summary>...</summary> comments on members.. An editor would be cool too. :)

«Midnight»

  • EA Guru
  • *****
  • Posts: 5651
  • Karma: +0/-0
  • That nice Mister Grey
    • View Profile
Re: XML doc comments
« Reply #1 on: August 27, 2007, 07:42:02 am »
Clever, Cleaver!

[Please search my recent posts for best practice on submitting this as a feature request directly to Sparx. If you do so, please note that in this thread.]

Sandcastle aside, this would be good regardless. The documentation paradigms used by Visual Studio and Java are slowly becoming the norm, rather than just a feature.

Code engineering support for these, in both directions, would be a powerful feature for EA.

David
No, you can't have it!

CleverCoder

  • EA User
  • **
  • Posts: 34
  • Karma: +0/-0
    • View Profile
Re: XML doc comments
« Reply #2 on: August 27, 2007, 07:54:05 am »
I think I might just do that!  But first, I need to continue my evaluation and need to convince the team that we should use this product as a standard for design documentation. I'm creating a shopping list of little "issues" I find. So far, EA is still better than any of the other tools, despite it's quirks.

Cheers!