Code Example Style Guide

This document outlines the commenting and documentation standards for all code examples in the Noderr Protocol documentation.

1. Commenting

  • Clarity: Comments should be clear, concise, and easy to understand.
  • Purpose: Comments should explain the why, not the what. The code itself should explain the what.
  • Completeness: Every function, class, and significant block of code should have a comment explaining its purpose.

2. Documentation

  • Docstrings: All public functions and classes should have a docstring that explains its purpose, parameters, and return value.
  • READMEs: Every code example should have a README file that explains how to run the example and what it does.

Maintained By: Noderr Protocol Team

results matching ""

    No results matching ""