Add @example JSDoc tag

Feature requests
Post Reply
sergey_che
Posts: 14
Joined: Tue Mar 11, 2008 10:04 am

Add @example JSDoc tag

Post by sergey_che » Mon Sep 01, 2008 1:03 pm

It will be a great help for JS coders (for me, at least :) to provide some example code snippets for code they're writing or using. Here's an example from JSDoc Toolkit documentation:

Code: Select all

/**
 * @example
 * var bleeper = makeBleep(3);
 * bleeper.flop();
 */

eric_suen
Site Admin
Posts: 678
Joined: Wed Sep 28, 2005 7:00 am
Contact:

Post by eric_suen » Mon Sep 01, 2008 3:47 pm

You means add @example tag into the code assist(for JSDoc) list?

sergey_che
Posts: 14
Joined: Tue Mar 11, 2008 10:04 am

Post by sergey_che » Mon Sep 01, 2008 4:16 pm

eric_suen wrote:You means add @example tag into the code assist(for JSDoc) list?
Add to code assist and treat data after @example tag as formatted code (display with monotype font and respect indentation and newline characters)

Post Reply

Who is online

Users browsing this forum: No registered users and 2 guests