Δημιουργήστε διαγράμματα Visio μέσω της Δωρεάν βιβλιοθήκης διαγραμμάτων Ruby

Ξεκινώντας με το RailRoad

Ο προτεινόμενος τρόπος εγκατάστασης του Railroad είναι η χρήση του RubyGems. Χρησιμοποιήστε την ακόλουθη εντολή για ομαλή εγκατάσταση

gem install railroad

go get github.com/speartail/RailRoad.git

Δημιουργία διαγράμματος με χρήση Ruby

Η βιβλιοθήκη ανοιχτού κώδικα Railroad διευκολύνει τον προγραμματιστή λογισμικού να δημιουργήσει ένα νέο διάγραμμα από την αρχή μέσα στις εφαρμογές Go. Η δημιουργία διαγραμμάτων χρησιμοποιώντας τη βιβλιοθήκη Railroad μπορεί να είναι ένας πολύτιμος τρόπος για να απεικονίσετε πολύπλοκες δομές δεδομένων και ροές εργασίας στον κώδικά σας. Χρησιμοποιήστε το Railroad για να δημιουργήσετε το διάγραμμα για τα μοντέλα σας. Οι προγραμματιστές λογισμικού μπορούν εύκολα να προσαρμόσουν περαιτέρω τα διαγράμματά τους επεξεργάζοντας απευθείας το αρχείο .dot. Μπορείτε να προσαρμόσετε τη διάταξη, το στυλ και άλλες οπτικές πτυχές του διαγράμματος σύμφωνα με τις προτιμήσεις σας. Το παρακάτω παράδειγμα δείχνει πώς να δημιουργήσετε

namespace :doc do
  namespace :diagram do
    desc "Creates diagram with all models including ones from gems and ones not connected to DB into Graphviz format (dot)"
    task :models do
      sh "railroad -i -l -a -m -p -t -j -M > doc/models.gv"
    end
    namespace :models do
      desc "Creates diagram for models into svg"
      task :svg do
        sh "railroad -i -l -a -m -M | dot -Tsvg | sed 's/font-size:14.00/font-size:11.00/g' > doc/models.svg"
      end
    end
    desc "Creates diagram for all controllers into Graphviz format (dot)"
    task :controllers do
      sh "railroad -i -l -C > doc/controllers.svg"
    end
    namespace :controllers do
      desc "Creates diagram for all controllers into svg"
      task :svg do
        Time.now.strftime
        sh "railroad -i -l -C | neato -Tsvg | sed 's/font-size:14.00/font-size:11.00/g' > doc/controllers.svg"
      end
    end
  end

  desc "Creates both diagrams, for models and controllers into Graphviz format (dot)"
  task :diagrams => %w(diagram:models diagram:controllers)

  namespace :diagrams do
    desc "Creates both diagrams, for models and controllers into svg"
    task :svg => %w(diagram:models:svg diagram:controllers:svg)
  end
end

Προβολή, κοινή χρήση διαγράμματος χρησιμοποιώντας τη βιβλιοθήκη Ruby

Η βιβλιοθήκη Railroad επιτρέπει στους προγραμματιστές λογισμικού να προβάλλουν τα διαγράμματά τους μετά τη γενιά και μπορούν να τα μοιραστούν με άλλα μέλη της ομάδας. Με το διάγραμμά τους που δημιουργείται και προσαρμόζεται, οι προγραμματιστές μπορούν τώρα να το χρησιμοποιήσουν για να τεκμηριώσουν τη βάση κώδικα τους ή να το μοιραστούν με την ομάδα τους. Τα διαγράμματα είναι ιδιαίτερα χρήσιμα για την ενσωμάτωση νέων μελών της ομάδας και την παροχή μιας επισκόπησης της δομής της εφαρμογής σας. Μπορείτε επίσης να χρησιμοποιήσετε το εργαλείο Graphviz για να δημιουργήσετε μια εικόνα PNG (ή άλλες υποστηριζόμενες μορφές) από το αρχείο .dot χρησιμοποιώντας την ακόλουθη εντολή.

Βελτιωμένη υποστήριξη τεκμηρίωσης και συνεργασίας

Ένας από τους κύριους λόγους για τους οποίους οι βιβλιοθήκες του Railroad έχουν κερδίσει δημοτικότητα είναι η ικανότητά τους να απλοποιούν πολύπλοκες ιδέες. Η οπτικοποίηση είναι ένα ισχυρό εργαλείο που μπορεί να κάνει πιο κατανοητές ακόμα και τις πιο περίπλοκες δομές κώδικα. Αντιπροσωπεύοντας τον κώδικα ως οπτικό «διάγραμμα σιδηροδρόμου», οι προγραμματιστές μπορούν να κατανοήσουν γρήγορα τη λογική πίσω από αυτόν, να εντοπίσουν πιθανά προβλήματα και να επικοινωνήσουν πιο αποτελεσματικά τις ιδέες τους. Στον σημερινό κόσμο των κατανεμημένων ομάδων και της ανάπτυξης ανοιχτού κώδικα, η αποτελεσματική συνεργασία είναι απαραίτητη. Οι βιβλιοθήκες του σιδηροδρόμου παρέχουν μια κοινή γλώσσα για τους προγραμματιστές για να συζητήσουν και να μοιραστούν ιδέες κώδικα. Με μια οπτική αναπαράσταση, οι προγραμματιστές μπορούν να επικοινωνούν πιο αποτελεσματικά, μειώνοντας τις πιθανότητες παρεξηγήσεων και σφαλμάτων.