protoc-gen-docs

Command protoc-gen-docs is the protoc plugin to generate documentation from the Protocol Buffers definitions.

Philosophy

Note

• AIP-192: Documentation

Documentation is one of the most critical aspects of API design.

Users of your API are unable to dig into the implementation to understand the API better; often, the API surface definition and its corresponding documentation will be the only things a user has.

Therefore, it is important that documentation be as clear, complete, and unambiguous as possible.

---

Note

• API Best Practices | Protocol Buffers Documentation

Precisely, Concisely Document Most Fields and Messages

---

Note

• Buf - Style guide

Over-document, and use complete sentences for comments.