Skip to content

code-comments.md

Latest commit

 

History

History
7 lines (6 loc) · 509 Bytes

code-comments.md

File metadata and controls

7 lines (6 loc) · 509 Bytes

Code Comments

  • All new or modified public items (pub fn, pub struct, pub enum, pub trait) MUST have English doc comments (///)
  • Add inline comments to explain why, not what — skip comments that merely restate the code
  • Do NOT retroactively add comments to unchanged code — only comment what you touch
  • Complex algorithms, non-obvious invariants, and safety-critical logic require comments even on private items
  • All comments, doc comments, and string literals must be in English