2009-06-08 10 views
17

Ich bin dabei, schriftliche Code-Standards für eine Rails-App zu entwickeln und bin auf der Suche nach einigen guten Beispielen für Coding-Standards, die von anderen entwickelt wurden. Etwas, das ein wenig auf die Ideen erweitert, die in ... diskutiert werdenGutes Beispiel für geschriebene Rails Codierungsstandards?

Hat jemand eine gute Referenz zu teilen?

http://www.scribd.com/doc/2889649/Rails-coding-standards-defined

Beispiele:

  1. STYLE: Line up Hash-Pfeile, um die Lesbarkeit
  2. STYLE: Räume setzen um => Hash-Pfeile
  3. STYLE : Leerzeichen nach ',' in Methode params einfügen - aber keine zwischen Methodennamen und '('

(Beachten Sie, dass ich zu Stackoverflow neu bin und nicht sicher, ob dies als eine „Frage“ zählt ... raten Sie bitte, ob nicht ...)

+1

'NICHT OPTIMIEREN für Leistung - OPTIMIEREN SIE FÜR KLARHEIT VON CODE' - Was zum Teufel! – bragboy

+0

@Bragboy das ist bekannte Ruby-Community-Philosophie. Denken Sie an Web-Anwendungen und wie die Optimierung jeder Zeile für die Leistung auf einer Webseite die Lesbarkeit stark verschlechtern würde, um die Ladezeit um vielleicht 0,5 Sekunden zu verkürzen. In diesen Zeiten sollte man die Code-Klarheit optimieren. Wenn Sie an einem Prozess arbeiten, der Hunderte oder Tausende Male durchlaufen muss, optimieren Sie die Leistung, ohne die Lesbarkeit zu sehr zu beeinträchtigen. – WattsInABox

+2

@WattsInABox: Einverstanden .. Ich denke, ich habe hier vor fast 18 Monaten zurück kommentiert. Ich muss zugeben, meine Perspektive hat sich geändert, als ich mehr und mehr Codezeilen schrieb. Klarheit zuerst, dann Leistung. – bragboy

Antwort

14

Hier ist ein Style Guide Ich mag eher,-Rubin fokussiert aber auf jeden Fall der "Rails Generation" von Rubyisten:

Elements of Ruby Style

Kredit, für den gehört zur Pathfinder Entwicklung:

pathfinder development logo http://www.pathf.com/sites/pfd/img/brand/logo.png

UPDATE. Zwei Jahre später, habe ich einen besseren Führer gefunden, vorbei geholt Ihnen the copycopter project

+0

Danke, das ist sehr nützlich. Ich suche nach etwas etwas umfassenderem (dh Schienen), aber das ist eine gute Ergänzung. Ich werde eine Antwort auf meine eigene Frage erstellen und hoffentlich andere hinzufügen und bearbeiten. In der Zwischenzeit kann jemand eine umfassende Liste von Richtlinien veröffentlichen –

3

ich zusammen diese Liste in einem Punkt: Acts as Good Style

deckt ein breites Spektrum von Aspekten der Schienen Entwicklung. Hin und wieder hake ich darüber und bringe es auf die neueste Rails-Version (wahrscheinlich müssen Sie das bald wieder tun) :)

4

Sie können einen Blick auf die Community Rails style guide werfen. Es ist ziemlich umfangreich und aktuell mit aktuellen Trends in der Entwicklung von Rails.

Verwandte Themen