Created
November 30, 2012 12:47
-
-
Save anasnakawa/4175556 to your computer and use it in GitHub Desktop.
javascript file comments structure
This file contains 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
| /*! | |
| * ------------------------------ | |
| * library name v#.#.# | |
| * http://library-url.com | |
| * license: MIT license (http://opensource.org/licenses/MIT) | |
| * ------------------------------ | |
| */ | |
| // ------------------------------ | |
| // table of content | |
| // ------------------------------ | |
| // a header title | |
| // - sub title | |
| // a method | |
| // ------------------------------ | |
| // a header title | |
| // -------------- | |
| // sub title | |
| // a method | |
| // describe your method | |
| // | |
| // * **param:** {type} paramName what to do with this parameter | |
| // | |
| // e.g: if you want to provide an example, that would be nice | |
| // ------------------------------ |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment