search

davidchambers / string-format

JavaScript string formatting inspired by Python’s `str.format()`
Do What The F*ck You Want To Public License
334 stars 36 forks source link

Missing header: author, version, license, ... #13

Open rognoni opened 8 years ago

rognoni commented 8 years ago

For example:

/****
 * string-format
 * https://github.com/davidchambers/string-format
 *
 * @author David Chambers <dc@davidchambers.me>
 * @link http://davidchambers.me
 * @version 0.5.0
 *
 * Released under MIT License. See LICENSE.txt or http://opensource.org/licenses/MIT
*/

https://github.com/rognoni/adaptable/blob/master/Front-end/HTML5-Bootstrap4/ext/string-format.js

davidchambers commented 8 years ago

I'm happy to add something like this. Is this a standard header? If so, where is it described. I'd like to know, for example, what @link means in this context.

rognoni commented 8 years ago

@davidchambers this format is only an example from this other external library that I'm using:

https://github.com/rognoni/adaptable/blob/master/Front-end/HTML5-Bootstrap4/ext/grapnel.min.js

Probably Grapnel uses the JSDoc syntax:

http://usejsdoc.org/tags-inline-link.html