I changed the title of this issue for a more generic one as almost all files needs more comments in code.
All the superBake files (Shells/tasks, libs, default template files (model snippets, actions, views, menus, files, required files,...) and the configuration file) should be well commented. Not especially step-by-step commented, but commented enough to be easily understood.
Already done:
[x] Config/bootstrap.php in f312177
[x] Console/Command/Task/BakeTask.php in f312177
[x] Console/Command/Task/SuperControllerTask.php in f312177
[x] Console/Command/Task/SuperFileTask.php in f312177
[x] Console/Command/Task/SuperModelTask.php in 2e0033f
[x] Console/Command/Task/SuperPluginTask.php in 2e0033f
[x] Console/Command/Task/SuperRequiredTask.php in 2e0033f
[x] Console/Command/Task/SuperViewTask.php in 2e0033f
[x] Console/Command/SbShell.php in 50ecec3
[x] Console/Command/ShellShell.php in 50ecec3
[x] Console/Configurations/superBakeConfig-empty.yml in c5d726082a
[x] Console/Configurations/superBakeConfig.yml in c5d726082a
[x] Lib/Superbake/Sbc.php in 071f9442b6
[x] Controller/DocsController.php in 071f9442b6
[x] Controller/SbAppController.php in 071f9442b6
[x] Controller/SbController.php in 071f9442b6
Notes:
Markdown, MarkdownExtended and Spyc should not be commented out, as no changes were made.
mtancoigne
commented
10 years ago
I changed the title of this issue for a more generic one as almost all files needs more comments in code.
All the superBake files (Shells/tasks, libs, default template files (model snippets, actions, views, menus, files, required files,...) and the configuration file) should be well commented. Not especially step-by-step commented, but commented enough to be easily understood.
Already done:
Notes: