jul-comments v1.5.9
JCS - JUL Comment System
About
JCS - JUL Comment System is a way of documenting your JavaScript source code while keeping the comments in a separate file. It allows you to associate the comments to any version of the source code and to get the updated commented code. Also, JCS is able to generate and to document the code for an entire JavaScript namespace or DOM tree loaded by a web page.
License
Licensed under GNU GPLv2 or later and under GNU LGPLv3 or later. See enclosed 'licenses' folder.
Features
- generates documented code from JavaScript source code or from runtime code
- saves the comments as a separate project for reuse and management of documenting different versions of the code
- recognizes types of data and generates comments blocks accordingly
- splits a JavaScript namespace into a custom number of child namespaces as documented source files with their corresponding code
- downloading the collection of generated source files as a zip package
System requirements
You may download the desktop application OR:
- a CSS2 compliant web browser with JavaScript 1.5 or later engine
- Node.js 0.10.0 or later installed
- OR a web server with PHP 5.2.0 or later extension
- 1024x768 minimum resolution
Install & usage in Node
Install & run locally for Linux/UNIX shells:
npm install jul-comments
"$(npm bin)/jul-comments"Install & run locally for Windows/DOS shells:
npm install jul-comments
for /f "tokens=*" %i in ('npm bin') do @"%i\jul-comments"Install JCS globally:
npm install -g jul-comments
Run server application: jul-comments. Use -h switch to see more options.
Use a browser to work with the app at http://localhost:7780/.
By default, the generated code is compatible with module.exports and can be required in a Node script.
Build & install from source
Install Node.js and Git command line in your system. Run the following shell commands in order:
npm install
npm run deps
npm run makeThe release will be in the 'build' folder. The Node module will be in the 'build_node' folder.