Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Polish code commenting / documentation. #89

Closed
tony opened this issue Aug 21, 2012 · 8 comments
Closed

Polish code commenting / documentation. #89

tony opened this issue Aug 21, 2012 · 8 comments
Labels

Comments

@tony
Copy link
Contributor

tony commented Aug 21, 2012

Here are 3 annotated sources generated by http://jashkenas.github.com/docco/.

Here is a blog post on it by Derick Baley, http://lostechies.com/derickbailey/2011/12/14/annotated-source-code-as-documentation-with-docco/.

@addyosmani
Copy link
Member

We currently have something like this setup in backbone-aura/docs/aura.html (which uses docco), but we could definitely be doing a better job of it now that we're started reorganizing the project a little. Leaving this open to explore further.

@tony
Copy link
Contributor Author

tony commented Aug 21, 2012

Ah, I see! In fact its my first time viewing that. Have we published backbone-aura's doccu online yet?

@addyosmani
Copy link
Member

Not yet, but given how old the current doc is we should probably try hooking docco up to our build process or something so we can do that more easily through launches. https://github.com/DavidSouther/grunt-docco could be of help here.

@addyosmani
Copy link
Member

@tony aside: would you like to become a full-member of the Aura team? If you're interested the project could definitely benefit from a keen eye on builds, code quality and how else we might improve in other areas.

@tony
Copy link
Contributor Author

tony commented Aug 21, 2012

@addyosmani Yeah absolutely. We have a good thing going here.

@addyosmani
Copy link
Member

@tony awesome. Added.

@dustinboston
Copy link
Contributor

@tony Welcome aboard!

@addyosmani
Copy link
Member

Closing due to age.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants