Có quy ước mã nhất định khi ghi lại mã ruby không? Ví dụ: tôi có đoạn mã sau:
require 'open3'
module ProcessUtils
# Runs a subprocess and applies handlers for stdout and stderr
# Params:
# - command: command line string to be executed by the system
# - outhandler: proc object that takes a pipe object as first and only param (may be nil)
# - errhandler: proc object that takes a pipe object as first and only param (may be nil)
def execute_and_handle(command, outhandler, errhandler)
Open3.popen3(command) do |_, stdout, stderr|
if (outhandler)
outhandler.call(stdout)
end
if (errhandler)
errhandler.call(stderr)
end
end
end
endĐiều này đoán điều này là ổn, nhưng có lẽ có những thực hành tài liệu tốt hơn / tốt hơn?
shop.oreilly.com/product/9780596516178.do có một ví dụ nhỏ đẹp trong mã nguồn. Xem trong danh sách chương 2. Nó giống như câu trả lời ở đây. Tôi đã chơi với ndoc chỉ để hiển thị mã nguồn. Bạn có thể làm cho phần mở rộng tệp của mình giống như my_code.rb thành my_code.rb.txt và sau đó chạy tệp trên đó. > rdoc my_code.rb.txt thì điều đó không thành vấn đề về các lớp và mô-đun bởi vì ndoc sẽ hiển thị html cho nó. Hãy vui vẻ với nó.
—
Douglas G. Allen