apexdox-vs-code
apexdox-vs-code copied to clipboard
The formatting of @author and @since does not meet the intended usage of these tags.
@author and @since are designed in JavaDoc so that one can maintain a version history... e.g.
/**
* @author Mark Smith <[email protected]>
* @since 2013-01-04 Created
*
* @author Bill C Riemers <[email protected]>
* @since 2020-09-04 US270544 - Added comments, switched to a private set from a public map
* @since 2022-09-08 Just a sample update
*/
This change log clearly indicates Mark Smith wrote this class in 2013-01-04 and it wasn't upaded again until 2020-09-04 by Bill C Riemers, and again I updated on 2022-09-08 as a sample of logging another change.
The generated output of;
Mark Smith <[email protected]> Bill C Riemers <[email protected]>
2013-01-04 Created 2020-09-04 US270544 - Added comments, switched to a private set from a public map 2022-09-08 Just a sample update
Is not really readable, as the since statements just all run together, and not nearly as useful, as you lose all information about who changed what.