[#FDT-552] Create ASDoc comments when generating methods

FDT

Create ASDoc comments when generating methods

Created: 21/Jun/09 06:31 PM Updated: 25/Jul/12 03:41 PM

Component/s:

ASDocs

Affects Version/s:

FDT 4.5.2

Fix Version/s:

FDT

Security Level:

public

Time Tracking:

Not Specified

Review Type:

Review by Product Owner

Description

« Hide

When generating methods there has to be the possibility to also generate the ASDocs for this method.

For example:
foo(1, "test"); >> auto completion generates:

/**
 * Insert documentation here
 * @param i
 * @param string
 */
private function foo(i : int, string : String) : void
{
}

Of course when I rename the parameters the param tags have to be renamed, too.

All

Comments

Work Log

Change History

Sort Order:

[ Permalink | « Hide ]

rico becker added a comment - 23/Jun/09 03:29 PM - edited

it would be perfect to get the ASDocs template only when i change the method to public.

[ Permalink | « Hide ]

Alan K (Deprecated) added a comment - 30/Jun/09 07:55 PM

Try this:

ActionScript 3.0 Auto Commenting for ASdoc

http://code.google.com/p/as3dac/

[ Permalink | « Hide ]

Hasan Otuome added a comment - 13/Jun/10 07:48 AM

Even if we could get the ability to add member comments via keyboard shortcuts would be helpful (creating a binding to Add JavaDoc Comment doesn't work).

In Flash Builder, you can type CMD + SHIFT + D on a Mac to add a comment block that includes the appropriate tags depending on the member's type (property vs. method)

[ Permalink | « Hide ]

Bruno Fonzi added a comment - 01/Jul/10 01:19 AM - edited

I like this feature, I can also smell the opportunity for a small FDT plug-in development here ...

[ Permalink | « Hide ]

Damien Laurent added a comment - 15/Mar/11 01:26 PM

The Eclipse keyboard shortcut is sufficient, but doesn't work with FDT, and workds with Flash Builder.

I'm talking about the shortcut :
Command : "Add Javadoc Comment"
Name : "Add a Javadoc comment"
Description : "Add a Javadoc comment stub to the member element"

Thanks !

[ Permalink | « Hide ]

Alan K (Deprecated) added a comment - 15/Mar/11 01:46 PM

Gotcha!

Thanks for continuing to follow up on this issue. This helps us keep tabs on what FDT developers want in the future.

[ Permalink | « Hide ]

Damien Laurent added a comment - 15/Mar/11 02:37 PM

I just noticed that the icon in Eclipse tool bar works fine, just the shortcut seems to be unefficient.

Icons :

/*
/*

and

/*

[ Permalink | « Hide ]

Alan K (Deprecated) added a comment - 04/Apr/11 06:56 PM

Consolidating tickets