Guidelines for writing developer and documentation comments. Use when modifying code, adding new features, or when explicitly asked to improve code documentation.
Follow these rules when writing comments in this workspace. Differentiate clearly between Developer Comments (internal implementation details) and Documentation Comments (public API usage).
Purpose: Clarify intent, implementation reasons, and complex logic for maintainers.
Purpose: Instruct clients on how to use the library/module API.
//)// for single or multi-line comments.unsafe blocks MUST be prefaced with a // SAFETY: ... comment explaining why preconditions are satisfied./// or //!)/// for the following item.//! for the containing item (e.g., module).# Safety Markdown section describing caller obligations.36:["$","$L3c",null,{"content":"$3d","frontMatter":{"name":"comments","description":"Guidelines for writing developer and documentation comments. Use when modifying code, adding new features, or when explicitly asked to improve code documentation."}}]