Chapter 2: Coding Standards

Establish a robust, compliant codebase documentation foundation. This chapter defines commenting standards and automated exclusion gates that ensure documentation accuracy and clean API parsing.

---

🧭 In This Chapter

📝 Commenting Rules

Learn the recognized @param/\param-style tags, the plain/NumPy/Sphinx-RST docstring dialects, and exactly how cross-references, images, and Hugo front matter are (and aren't) handled.

🚧 Exclusion Gates

Learn how @internal/\internal and conditional blocks silently drop entities from the catalog — and why there is no path- or namespace-based exclusion configuration today.