[#FDT-2534] Code Hint Support In ASDoc Comments

FDT

Code Hint Support In ASDoc Comments

Created: 13/Jan/12 03:50 PM Updated: 22/Jun/12 06:42 PM

Component/s:

ASDocs, Quick Fix / Assist

Affects Version/s:

FDT 5.0

Fix Version/s:

FDT

Security Level:

public

Time Tracking:

Not Specified

Review Type:

Review by Product Owner

Description

« Hide

Now that we have ASDoc support, FDT could help developer create the documentation by giving code hint or perhaps even an automated way of doing it. A Quick Assist could be great actually. Image putting your cursor at the delcaration of a method, hitting Quick Assist and having FDT add an ASDoc comment with:

@param for each parameter (if they exist)
@return (if it returns a value)
@throws (if it throws any errors)

Besides that autocomplete for the other options is helpful as well. Please see this for more info.

http://help.adobe.com/en_US/flex/using/WSd0ded3821e0d52fe1e63e3d11c2f44bc36-7ff6.html

Also, some developers like to have the ASDoc creating auto created for them. Consider adding an option for the to happen when a method is created.
Something else is an option to refactor or update ASDoc. For example of the method signature changes.

All

Comments

Work Log

Change History

Sort Order:

[ Permalink | « Hide ]

Panel added a comment - 19/Jan/12 11:01 AM

A agree it would be nice if this template would be added automatically when method is created.
Currently I am using such template

/**
 * TODO: Add Method Description
 * 
 * TODO: @param
 * TODO: @default
 * TODO: @return
 * TODO: @events
 * TODO: @throws
 * TODO: @see
 */

I am thinking about user defined template in general settings with ability to override in project.