SabreTools/BinaryObjectScanner
1
0
Fork 0
mirror of https://github.com/SabreTools/BinaryObjectScanner.git synced 2026-09-21 22:34:58 +00:00
Code Issues 295 Packages Projects Releases 20 Wiki Activity

Add note about first-person comments

Browse Source
This commit is contained in:
Matt Nadareski
2024-10-27 00:04:11 -04:00
parent 284d0ea108
commit 165896e335
1 changed files with 2 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
Coding Guide.md
View File

@@ -291,6 +291,8 @@ This section contains information on code standards regardless of which part of
- Comments should be expressive and fully explain what is being described. Try to avoid using slang, "pointed comments" such as "you should" or "we do".
- Comments should avoid the use of first-person writing, such as "I think" or "We found".
- If comments include links, they can either be included as-is or using the `<see href="value"/>` tag
```c#