Add to Chrome
Add to Edge
Add to Firefox
Add to Opera
Add to Brave
Add to SafariWhen comparing Docco vs YUIDoc, the Slant community recommends Docco for most people. In the question“What are the best JavaScript documentation tools?” Docco is ranked 2nd while YUIDoc is ranked 4th. The most important reason people chose Docco is:
Since Docco doesn't enforce any comment style or rules, it's great for beginners who can instantly pick up without having to learn any new syntax or style.
Question Ranking
Pros
Pro Great for beginners
Since Docco doesn't enforce any comment style or rules, it's great for beginners who can instantly pick up without having to learn any new syntax or style.
Pro Markdown support
All the comments are run through a markdown parser, while all the code is run through Highlight.js for code highlighting.
Pro Cross-platform
YUIDoc is not available for JavaScript only, it supports every language that has /**/ comment blocks.
Pro Great output
YUIDoc's default theme is very appealing. The output it renders is very readable, searchable and user-friendly.
Pro Live preview
A standalone doc server is included which allows you to easily preview the documentation as it's being written.
Cons
Con Does not enforce a pattern in writing comments
Since Docco only accepts comment lines starting with double slashes, it does not really enforce any pattern in writing comments, at least not as much as it would if it would use comment blocks. This can bring a huge disparity and even make it harder for Docco to generate good documentation as the project grows larger.
Con The name of the method/class need to be mentioned in the comments
Since YuiDoc only parses comment blocks, it requires the names of the methods to be specified there, ignoring what's outside of the comment block.
