~/VibeHandbook
PDF бесплатно

Глава 08 · 06

Приводите примеры

Один конкретный пример стоит абзаца описания. Если вы хотите вывод в определённой форме, покажите эту форму. Это самый быстрый способ устранить неоднозначность.

Отформатируй данные красиво.
Преобразуй этот массив пользователей в сводный объект.

Input:
  [{ name: "Ann", role: "admin" }, { name: "Bo", role: "user" }]

Desired output:
  { total: 2, byRole: { admin: ["Ann"], user: ["Bo"] } }

Напиши функцию преобразования и тест, соответствующий этому примеру.

Примеры фиксируют именование, структуру и регистр, которые одни слова оставляют расплывчатыми. Когда можете, включайте пример как тест — тогда «сделай так, чтобы тест прошёл» становится однозначной инструкцией. Приём обобщается: образец ответа (интерфейс программирования приложений — способ, которым одна программа запрашивает данные у другой) фиксирует парсер, пара «до/после» фиксирует рефакторинг, скриншот или ASCII-набросок фиксирует вёрстку. Всякий раз, поймав себя на написании длинного описания некой формы, остановитесь и покажите вместо этого один экземпляр этой формы.

Хотите офлайн-версию?

Скачайте всю книгу в PDF или EPUB — бесплатно.