jprdonnelly/docs
1
0
Fork 0
mirror of synced 2025-12-19 18:10:59 -05:00
Code Issues Projects Releases Wiki Activity

Always include HTML closing tag for annotations (#39058)

Browse Source
This commit is contained in:
Sarah Edwards
2023-07-13 15:48:56 -07:00
committed by GitHub
parent b9bcfa2314
commit d4687d2c68
1 changed files with 1 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
contributing/code-annotations.md
View File

@@ -34,7 +34,7 @@ Within code sample annotations:
- Multiple sequential comments will create a single annotation. - Multiple sequential comments will create a single annotation.
- Lines that do not start with a comment tag and are empty or only contain spaces will be ignored. - Lines that do not start with a comment tag and are empty or only contain spaces will be ignored.
- You must start the code section with a single line comment. If the first line (or section) of the code does not need an annotation, you can use a comment tag with no text to create a blank annotation. - You must start the code section with a single line comment. If the first line (or section) of the code does not need an annotation, you can use a comment tag with no text to create a blank annotation.
- For HTML style, you can include a closing tag, `<!-- -->`, after your annotations to maintain syntax highlighting; this will not impact how the annotations render. - For HTML style, you should include a closing tag, `<!-- -->`, after your annotations to maintain syntax highlighting.
## Writing code annotations ## Writing code annotations