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

[Q||FR]Is it possible to write symbols in code block as html entities? #594

Closed
ZuBB opened this issue Dec 7, 2014 · 1 comment
Closed

Comments

@ZuBB
Copy link

ZuBB commented Dec 7, 2014

Hi there!

First of all I would like to say 'thank you' for this great (IMO its best) software for JS code documentation.

I have next doc

/**
 * ...
 * build it using release target. Format of that magic comments is next
 *
 * ```
 * //DEBUG_START
 * _d('I want to have this message only in development mode');
 * //DEBUG_STOP
 * ```
 *
 * You can do ...
 */

With help of that DEBUG_(START|STOP) pair I strip (with help of self-written grunt plugin) debug code from result file. However I would like to have code above not being processed by that system. I tried to get this working by replacing // with '//'. But that trick of course did not work. Is it possible to achieve that with some magic on jsduck side?

@nene
Copy link
Member

nene commented Dec 7, 2014

I don't think there's any simple way to achieve that with JSDuck, other than hacking on JSDuck doc-comment parser itself.

Then again, it should be easy to solve this outside JSDuck. Just strip all these DEBUG sections from code before having JSDuck parse it.

@nene nene closed this as completed Dec 7, 2014
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