#82 Support for Delphi recommended comment format

[TheRoadrunner]

Comments in the format
/// <summary> some description.
/// </summary>
/// <returns> result
/// </returns>
/// <param name="Sender"> (TObject)</param>
is the recommended format from Borland/CodeGear as it is immediately supported by CodeInsight.
AFAIK this format is not supported by DelphiCodeToDoc, IMHO that is the most important one.

[TridenT]

Logged In: YES
user_id=248829
Originator: NO

Yes, this is a major and most important feature.
Priority raised.

[TheRoadrunner]

Logged In: YES
user_id=1744299
Originator: YES

In version 0.20 the (abbreviated) <summary> part is shown in the class methods overview, but in the detailed method view, the whole comment is shown uninterpreted in description.
Being the only priority 9 feature request, when do you plan to work on this ?

[TridenT]

Logged In: YES
user_id=248829
Originator: NO

Can you show me an example or a screenshot please ?

when do you plan to work on this ?

I'm sorry to say I really don't know.
For the moment, i'm fixing critical bugs, it will be the v.021b revision.

After, I will work on this feature.
I am alone to code DelphiCodeToDoc, even if many guys like you help by submitting bugs and features, and/or give adives, I'm the only one to code.
Since I'm doing DelphiCodeToDoc in my free time, the time assigned will vary from days to days.

I'm sorry to say I have no idea about a plan.
If you want to help, don't hesitate to contat me !

[TheRoadrunner]

Logged In: YES
user_id=1744299
Originator: YES

Hi Trident

Thanx for your quick response.
I didn't mean to push you, I know you do it on your free time and I respect the good work that you do.
I would love to participacte in the project, but I can't find the time right now.
I have posted a pdf showing an example of my point.

Best regards
Søren
File Added: DelphiDocToCode.pdf

[TheRoadrunner]

Example of comments recommended by CodeGear.

[TridenT]

Logged In: YES
user_id=248829
Originator: NO

OK, I was not aware that the summary works fine with XMLdoc.
Great !

but it works without any modification ;o)
Ok, thx for your help, I know understand the issue.
I will notify you when I have the time to work on this point.

[TridenT]

Do you know where I can find all tag from XmlDoc described ?

[TridenT]

Only found this :
http://msdn.microsoft.com/en-us/magazine/cc302121.aspx

[Zoë Peterson]

There's a good description of the Delphi tags here:
http://www.devjet.net/announcements/delphi-documentation-guidelines/

[TridenT]

Good link. It will helps me to finish the implementation.
Thx for sending it !