hohn/codeql
1
0
Fork 0
mirror of https://github.com/github/codeql.git synced 2026-04-30 11:15:13 +02:00
Code Issues Packages Projects Releases Wiki Activity

JS: mention @type tag in qhelp

Browse Source
This commit is contained in:
Asger F
2018-10-31 10:45:20 +00:00
parent ad7ecc1df0
commit e670919807
1 changed files with 5 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
javascript/ql/src/Expressions/SelfAssignment.qhelp
View File

@@ -15,6 +15,11 @@ Assigning a variable to itself typically indicates a mistake such as a missing
Carefully inspect the assignment to check for misspellings or missing qualifiers.
</p>
<p>
If the self-assignment is intentional, and is needed for documentation or optimization purposes,
add a JSDoc comment with a <tt>@type</tt> tag. This will indicate the self-assignment is intentional.
</p>
</recommendation>
<example>