How to document example output

u-now / types-x

eXtend ServiceNow development with type definitions

MIT License

1 stars 3 forks source link

How to document example output #14

Closed animyeboah closed 5 years ago

animyeboah commented 5 years ago

How should we document in JSDoc the "Output" part of the example code?

screenshot 2019-03-05 at 1 19 16 pm

I'm doing it like this:

/** ...
  * 
  * @example
  * 
  * var gd =new GlideDate(); 
  * gd.setValue('2015-01-01');
  * gs.info(gd.getDisplayValue());
  * // Output: 2015-01-01

johncaruso commented 5 years ago

Just comment the expected output: * // 2015-01-01