15.21. Tworzenie dokumentacji witryny WWW
Problem
Chcemy stworzyć dokumentację sterowników, modeli i modułów pomocniczych aplikacji internetowej, tak by programiści odpowiedzialni za utrzymanie aplikacji zrozumieli zasady jej działania.
Rozwiązanie
Podobnie jak w przypadku innych programów w języku Ruby, dokumentację aplikacji Rails tworzy się poprzez wprowadzenie w kodzie specjalnie sformatowanych poleceń. Poniżej pokazano sposób tworzenia dokumentacji dla klasy FooController i jednej z jej metod:
# Sterownik FooController udostępnia różne własności funkcjonalne, # które są niedostępne w innych sterownikach. class FooController < ApplicationController # Akcja set_random ustawia zmienną egzemplarza @random_number # na losową liczbę. ...
Get Ruby. Receptury now with the O’Reilly learning platform.
O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.
