You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
It's not uncommon to have a block comment at the top of a class, added at the time of creation, describing the intention of the class and including a section for changes. The usefulness of most these comments tends to be short-lived, as they're not updated and people move on from the project. A more accurate representation of the information can generally be obtained through the use of git blame.
Example:
/******************************************************************************************* Created By : William Brockhus* Release : v1* Description : This class does some things and stuff** Modification Log:* -----------------------------------------------------------------------------* Developer Date Description* ----------------------------------------------------------------------------* William Brockhus 2021-06-16 Created* *****************************************************************************************/
If such a block must be included, keep to the minimum information necessary, and consider using jsdoc tags as they add highlighting.
Example:
/** * @description This class does some things and stuff */
The text was updated successfully, but these errors were encountered:
It's not uncommon to have a block comment at the top of a class, added at the time of creation, describing the intention of the class and including a section for changes. The usefulness of most these comments tends to be short-lived, as they're not updated and people move on from the project. A more accurate representation of the information can generally be obtained through the use of
git blame
.Example:
If such a block must be included, keep to the minimum information necessary, and consider using jsdoc tags as they add highlighting.
Example:
The text was updated successfully, but these errors were encountered: