Mardi c'est RDoc
gem install rdoc
Documenter ses projets
RDoc est l’une des solutions possibles pour avoir une jolie documentation qui permettra à vous, vos collègues et votre chat de pouvoir rapidement lire et comprendre votre code.
Et comment ça marche ? Et bien on écrit le code avec des commentaires, par exemple un model utilisateur :
Ruby
class User < ActiveRecord::Base
devise :database_authenticatable, :recoverable, :rememberable, :trackable, :validatable
attr_accessible :firstname, :lastname, :email, :password, :password_confirmation, :remember_me, :is_admin
after_create { |user| user.send_reset_password_instructions }
# permet de créer un utilisateur sans mot de passe
def password_required?
new_record? ? false : super
end
end
Et un petit coup de :
rake doc:app
Je vous laisse apprécier, et parcourir les liens utiles pour en savoir plus :