Created
September 29, 2021 09:57
-
-
Save abdorah/89c567361f03f9710a118a7ac2d3cdc1 to your computer and use it in GitHub Desktop.
How to write clean comments.js
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| /** | |
| * @description This function generates the button required for Action Bar | |
| * @author Ashish | |
| * @param { Function } t => translation function | |
| * @param { Object } history => contains previous state | |
| * @param { Function } print => property passed from parent to print | |
| * @returns { Array } buttons array of Objects | |
| * @see {@link https://stackoverflow.com/users/5282407/ashish-singh-rawat } | |
| * @todo Performance optimisation, removing multiple loops | |
| * * BELOW ARE SOME MORE META DATA, that can be used | |
| * @argument @async @borrows @class @classdesc @constant | |
| * @constructor @copyright @default @deprecated @emits | |
| * @enum @event @example @extends @external @field @file | |
| * @fileoverview @fires @function @generator @global | |
| * @hideconstructor @host @ignore @implements @inheritdoc @inner | |
| * @instance @interface @kind @lends @license @listens @member @memberof | |
| * @method @mixes @module @name @namespace @override @param @private @property | |
| * @protected @public @readonly @returns @see @since @static @summary @template | |
| * @this @throws @tutorial @type @typedef @var @variation @version @virtual | |
| * @yields | |
| **/ |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment