Skip to content

Update GETTING_STARTED.md #1294

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Mar 17, 2020
Merged

Update GETTING_STARTED.md #1294

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9b9f1ae
Update GETTING_STARTED.md
NileshArnaiya Oct 30, 2019
f0dc4d9
Update GETTING_STARTED.md
tmcw Mar 10, 2020
5facb92
Merge branch 'master' into patch-1
tmcw Mar 17, 2020
921519c
Update GETTING_STARTED.md
tmcw Mar 17, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 12 additions & 13 deletions docs/GETTING_STARTED.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ On the second line:

* `@param` is **a tag**: This tag indicates that we'll be documenting a function's parameter.
* `{number}` is **a type**. It says that the input to this function is
a JavaScript "number". It could also say `{string}`,
a JavaScript "number." It could also say `{string}`,
`{Object}`, `{Date}`, or any other JavaScript built-in type. And if you
defined a custom class, like `FooClass`, you can use it as a type, too! Just say `{FooClass}`.
* `input` is the name of the input variable. It matches what the code
Expand Down Expand Up @@ -96,7 +96,7 @@ populates `@name`, `@kind`, and `@memberof` tags based on its reading of the
code.

**Normalization**: JSDoc has multiple words for the same thing: you can
say `@augments` or `@extends` and they'll do the same thing.
say `@augments` or `@extends`, and they'll do the same thing.

## Development Process

Expand All @@ -108,17 +108,16 @@ automated style check.
## The Tags

[**`jsdoc.app`**](https://jsdoc.app/) covers all available tags in the
JSDoc syntax, and is a great reference.

The most commonly used tags are:

* `@param` - input given to a function as an argument
* `@returns` - output value of a function
* `@name` - explicitly set the documented name of a function, class, or variable
* `@private` - you can use `@private` to document
code and not have it included in the generated documentation;
maybe it's not part of the public API. There's also `@public` and `@protected`
* `@example` - you can use the `@example` tag to add inline code examples with your
JSDoc syntax, and is a great reference. The most commonly used tags
are:

* @param - input is given to a function as an argument
* @returns - output value of a function
* @name - explicitly set the documented name of a function, class, or variable
* @private - you can use @private to document
code and not have it included in the generated documentation,
maybe it's not part of the public API. There's also @public and @protected
* @example - you can use the @example tag to add inline code examples with your
documentation

If your text editor does not highlight JSDoc tags,
Expand Down