Premudo Blog

Dokumentation von Rails Modellen leicht gemacht

Jeder kennt das – man schreibt an einem Model (ja dem 98 von 200) und weis einfach nicht wie nochmal diese eine Spalte genau heist. Da gibts Abhilfe. Ein kleines Plugin hilft bei der Dokumentation der Spalten und schreibt diese in den Header des Models auf Basis des Tabellenlayouts aus der Datenbank. Das Ganze ist zwar schon älter aber immer noch unheimlich nützlich finde ich. Wer es sich runterladen will findet es beim PragDave Blog . Dieses Plugin wird einfach installiert mit

script/plugin install http://repo.pragprog.com/svn/Public/plugins/annotate_models

installiert. Mit

rake annotate_models

ist der Spaß schon geschehen und man hat eine feine Dokumentation in den Modellen. Gefunden hab ichs bei Labuschin Webdesign Nachtrag So eine Dokumentation sieht so aus:


# == Schema Information
# Schema version: 20080826104906
#
# Table name: subtotals
#
#  id                :integer(11)     not null, primary key
#  offer_id          :integer(11)
#  amount            :decimal(8, 2)
#  offer_category_id :integer(11)
#

Wenn man mit einem Versionsverwaltungssystem wie GIT oder SVN arbeitet ist zu beachten, dass im Header immer die Schema Version nach einem “rake annotate_models” geändert wird und dadurch das Versionsverwaltungssystem “glaubt”, dass sich da irgendwas verändert hat. Das hat es im Grunde ja auch aber es ist es nicht Wert, in die Historie aufgenommen zu werden. Ich weiß leider nicht, wie man GIT oder SVN beibringt, nicht auf diese Änderung zu achten. Also bitte Kommentare falls jemand einen guten Vorschlag hat.

Dokumentation von Rails Modellen leicht gemacht

Ähnliche Blogs

Leave a Reply

OpenID

Anonymous