- marked as minor
- edited description
Allow configuration of the template for default ApexDoc header comments
Issue #2266
duplicate
Hi Scott,
I propose to improve the default ApexDoc generation.
- Currently the auto-generated ApexDoc looks like this:
-
I would prefer to capture:
- the created date using the @since tag
- the author using the @author tag
-
Ideally, the author should be configurable:
- Instead of the user on the machine, it should be possible to provide one’s author string e.g. “Firstname LastName <email_address>”
In combination with issue , the end result would look more like this:#2265
This would save me quite a bit of work. In my humble opinion, this would also allow newbees to better understand the usage of ApexDoc and foster better ApexDoc usage.
Thanks for considering.
Comments (6)
-
reporter -
reporter - edited description
-
repo owner And the same thing mostly applies here. You could update the file templates to include those for all newly-created Apex types if desired. I’ll leave this one open, though, as it could apply to the header created by typing
/**<ENTER>
immediately above a declaration or by using the Add ApexDoc comment code intention. -
repo owner - changed title to Allow configuration of the template for default ApexDoc header comments
- removed version
-
repo owner - edited description
- changed component to ApexDoc
-
repo owner - changed status to duplicate
Duplicate of #1610.
- Log in to comment