JSDoc adding real code in documentation

Posted by Marco Demaio on Stack Overflow See other posts from Stack Overflow or by Marco Demaio
Published on 2010-06-02T20:21:47Z Indexed on 2010/06/02 20:24 UTC
Read the original article Hit count: 247

Filed under:

Do you know if there is a some sort of <code> tag in JSDoc? I need to add pieces of code in mt documentation like this:

/**
* This function does something see example below:
* <p>
* var x = foo("test"); //it will show "test" message
*
* @param {string} str: string argumnet that will be shown in message
*/
function foo(str)
{
   alert(str);
}

I need that the code in the comments being displaied by JSDoc as code (if not sintax highlighetd, at least as code like in preformatted or something with grey background)

Thanks.

© Stack Overflow or respective owner

Related posts about jsdoc