Конвенции документирования - adaon/jaspi-node GitHub Wiki

Документация модуля

• Имя модуля.
• Функциональность и требования модуля.
• Классы модуля:
  • Имя класса.
  • Описание класса.
• Функции модуля.

Документация класса

• Имя класса.
• Функциональность и требования класса.
• Интерфейс класса (методы).

Документация метода

• Имя метода со списком аргументов.
• Описание метода.
• Описание аргументов метода.
• Описание возвращаемого значения.