TheLanc3/rustdesk
1
0
Fork 0
mirror of https://github.com/rustdesk/rustdesk.git synced 2026-09-21 03:40:59 +03:00
Code Issues Packages Projects Releases Wiki Activity

improve comment rules

Browse Source
This commit is contained in:
rustdesk
2026-08-18 12:31:59 +08:00
parent 9b1b810d3a
commit 0c00d576dd
1 changed files with 3 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
AGENTS.md
View File

@@ -63,10 +63,9 @@
### Comments ### Comments
* Keep them short: one line by default, three at most. * Avoid comments unless they explain a non-obvious reason, constraint, or workaround.
* Say **why**, never what. If the code already says it, delete the comment. * Never restate what the code does; prefer clearer code instead.
* A comment must never be longer than the code it describes. * If the code is self-explanatory, add no comment.
* Applies to YAML, shell and Python too, not just Rust.
### Be minimally invasive ### Be minimally invasive