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

State in docs that Docco only supports single line comments #206

Open
nikmartin opened this issue May 2, 2013 · 1 comment
Open

State in docs that Docco only supports single line comments #206

nikmartin opened this issue May 2, 2013 · 1 comment

Comments

@nikmartin
Copy link

I'm using docco on a node.js project, and nowhere in the page http://jashkenas.github.io/docco/ is the list of comment sugar, if any, Docco supports. I Joogled several times, finally ending up on a bunch of closed issues that I gather docco supports single line comments in the language's native one line comment format. It would be nice if the web page stated that not so obvious fact. I came in assuming you'd grok the popular comment sugar like /** /, etc, and maybe even @Class and @function voodoo. Now I've got 0 issue with the fact it doesn't do any of this, but I burnt 30 minutes trying to figure out this fact. I'm building a REST API, so I need to document the REST endpoints, and thought docco might assist. Again, no issues there, but the home page should maybe state that

"Docco [currently] supports single line comments in the language's native format. It doesn't [currently] support any other documentation system's comment sugar"

@G07cha
Copy link

G07cha commented Jul 8, 2015

I have same situation too, be awesome if @jashkenas add multi-line comments support.

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

No branches or pull requests

2 participants