Syntax of param tag
WebDec 17, 2024 · The syntax used in the parameter description is the following. @param[in/out] ... This tag on one of our markdown files will tell the Doxygen parser that a given markdown file is the main page for the project. WebSyntax: The @param tag is used to document a function or method parameter. The @param tag is followed by the parameter name, followed by a hyphen, followed by a description. Being a block tag, @param introduces a TSDoc section that contains all comment text up until the next block tag. NOTE: JSDoc's version of the @param tag optionally allows ...
Syntax of param tag
Did you know?
WebThe tag passes the parameters to the objects embedded with the , , and elements. See examples. The tag passes ... Syntax. The tag is empty, which … WebThis inline tag can be used anywhere that a comment can be written, such as in the text following block tags. If you have more than one paragraph in the doc comment, separate …
WebNote: In HTML, the end tag for the tag is forbidden. In XHTML, the tag must be closed with a trailing slash, like this: . The example below shows the tag in action. WebDec 2, 2024 · param-name The name of a method parameter. Enclose the name in single or double quotation marks. The compiler issues a warning if it doesn't find param-name. …
WebYou can reference types with the “@type” tag. The type can be: Primitive, like string or number. Declared in a TypeScript declaration, either global or imported. Declared in a JSDoc @typedef tag. You can use most JSDoc type syntax and any TypeScript syntax, from the most basic like string to the most advanced, like conditional types. /**. WebApr 22, 2013 · Add a comment. 6. @param will not affect testNumber.It is a Javadoc comment - i.e used for generating documentation . You can put a Javadoc comment …
WebJan 19, 2024 · Syntax notes: The @param tag is followed by an optional data type indicator, then the variable name of the parameter, and then a newline. The following paragraph is considered by the API module to be documentation.
WebW3Schools offers free online tutorials, references and exercises in all the major languages of the web. Covering popular subjects like HTML, CSS, JavaScript, Python, SQL, Java, and … fred west much marcleWebAttributes. Attributes can be added to an HTML element to provide more information about how the element should appear or behave.. The element accepts the following … fred west house numberWebW3Schools offers free online tutorials, references and exercises in all the major languages of the web. Covering popular subjects like HTML, CSS, JavaScript, Python, SQL, Java, and … blippi winter songWeb3 rows · Attribute Value Description; Name: text: It determines the name of the parameter. value: text: It ... blippi winterWebmissing parameter tag: @arg, @argument, or @param; inconsistent order of parameter names in a comment compared to the function or method; missing return tag: @return or @returns; missing parameter or return type; missing parameter or return description; syntax error; This rule does not report missing JSDoc comments for classes, functions, or ... fred westphal obituaryWebSyntax kind: Block tag: Usage. Used to document a function parameter. The @param tag is followed by a parameter name, followed by a hyphen, followed by a description. Example … fred west mother and fatherWebThis element is also available in our updated HTML 4 reference. Some characteristics may have changed. None ( Empty ). APPLET. The PARAM element is used to provide … blippi winter sports