Convert XML code comments to the JSDoc format
Use xmltojsdoc to convert XML comments common in C# and .NET to JSDoc-formatted comments.
Before:
///<summary>Adds event listeners to a button</summary>
///<param name="elem" type="Element">Button element</param>
///<param name="options" type="Object">Optional settings</param>
///<returns>True if successful, false if unsuccessful</returns>
///<remark>If no `elem` is specified, the first `.button` on the page will be used</remark>
After:
/**
* Adds event listeners to a button
*
* If no `elem` is specified, the first `.button` on the page will be used
*
* @param {Element} elem Button element
* @param {Object} options Optional settings
* @return {[type]} True if successful, false if unsuccessful
*/
npm: npm install xmltojsdoc
Or just download xmltojsdoc.js and reference it in your page with a <script> tag.
Available as a CommonJS module (e.g with RequireJS) or as a global method:
var jsdoc = xmltojsdoc.convert(jsWithXMLComments);You may pass any string (such as a complete JS or HTML file) and xmltojsdoc will intelligently pick out the comment blocks.
Or use the online converter to match up the results with the line numbers in your source file.
