diff --git a/inline-documentation-standards/javascript.md b/inline-documentation-standards/javascript.md index 8b1b335..7a792ad 100644 --- a/inline-documentation-standards/javascript.md +++ b/inline-documentation-standards/javascript.md @@ -1,6 +1,6 @@ # JavaScript Documentation Standards -WordPress follows the JSDoc 3 standard for inline JavaScript documentation. +WordPress follows the JSDoc 3 standard for inline JavaScript documentation.

What Should Be Documented

JavaScript documentation in WordPress takes the form of either formatted blocks of documentation or inline comments. @@ -88,7 +88,7 @@ Functions should be formatted as follows:
  • @fires: Event fired by the function. Events tied to a specific class should list the class name.
  • @listens: Events this function listens for. An event must be prefixed with the event namespace. Events tied to a specific class should list the class name.
  • @global: Marks this function as a global function to be included in the global namespace.
    • -
  • @param: Give a brief description of the variable; denote particulars (e.g. if the variable is optional, its default) with JSDoc @param syntax. Use a period at the end.
    • +
  • @param: Give a brief description of the variable; denote particulars (e.g. if the variable is optional, its default) with JSDoc @param syntax. Use a period at the end.
  • @yield: For generator functions, a description of the values expected to be yielded from this function. As with other descriptions, include a period at the end.
  • @return: Note the period after the description.