Try it out
Index
Source Code
Test Code
Manual
Config
init
# Welcome to ESDoc This is the place to try ESDoc. Please write a code and click `Try it out`! - `Index` (this) is used as a index page(Markdown). - `Source Code` is used as a source code(JavaScript) - `Test Code` is used as a test code(JavaScript). - `Manual(Usage)` is used as a manual of usage(Markdown). - `Config` is used as a configuration(JSON).
/** * this is BaseClass. */ export class BaseClass { /** * this is a method of BaseClass. * @returns {string} a greeting. */ baseMethod(){ return 'this is base method'; } } /** * this is MyClass. */ export default class MyClass extends BaseClass { /** * creates a instance of MyClass. * @param {number} value - initial value. */ constructor(value){ /** * this is property of MyClass. * @type {number} * @private */ this._property = value; } /** * this is method of MyClass. * @param {number} a - this is a 1st number value. * @param {number} b - this is a 2nd number value. * @returns {string} repeated Hello */ method(a, b){ return 'Hello'.repeat((a + b) * this._property); } }
/** * this is test for MyClass. * @test {MyClass} */ describe('test MyClass', ()=>{ /** * this is test for MyClass#method. * @test {MyClass#method} */ it('has a method', ()=>{ assert(new MyClass(100).method); }); });
# Usage This is usage for MyModule that is written by GitHub Flavored Markdown. - this is list item1 - this is list item2 - this is list item3 ```js const myClass = new MyClass(100); const hello = myClass.method(1, 2); console.log(hello); ```
{ "source": "__SOURCE__", "destination": "__DESTINATION__", "index": "__INDEX__", "plugins": [{ "name": "esdoc-standard-plugin", "option": { "test": {"source": "__TEST__"}, "manual": {"files": ["__MANUAL__"]} } }] }
Please try it out
<
