[ALOY-977] Add code comments
| GitHub Issue | n/a |
|---|---|
| Type | Improvement |
| Priority | Medium |
| Status | Resolved |
| Resolution | Fixed |
| Resolution Date | 2014-12-30T19:33:57.000+0000 |
| Affected Version/s | n/a |
| Fix Version/s | Alloy 1.7.0 |
| Components | Documentation |
| Labels | n/a |
| Reporter | Tim Poulsen |
| Assignee | Tim Poulsen |
| Created | 2014-04-01T20:08:56.000+0000 |
| Updated | 2014-12-30T19:33:57.000+0000 |
Description
Add comments to the alloy scripts, specifically to the compile-related files. Code comment structure should be compatible with the TBD code-doc tool.
Candidate tools include: * Docco * Gilt (a fork of Groc which is a fork of Docco https://github.com/gilt/groc) * Flatdoc (not best for code documentation as it works with separate markdown files rather than inline code comments) * JSDuck * YUIDoc, or JSDocs
This ticket could be never-ending. But I've made a PR that includes code comments and readme files. These are at least a good start. Ongoing, all new code should be commented. PR https://github.com/appcelerator/alloy/pull/636 The code comments are not implemented to specifically work with any of the tools listed in my previous comment. Alloy doesn't lend itself particularly well to automated source code documentation, as it's not an API or library.
PR merged