রুবি কোড ডকুমেন্ট করার সময় কি কিছু কোড কনভেনশন রয়েছে? উদাহরণস্বরূপ আমার কাছে নিম্নলিখিত কোড স্নিপেট রয়েছে:
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এই অনুমান এটি ঠিক আছে, তবে সম্ভবত আরও ভাল / উচ্চতর ডকুমেন্টেশন অনুশীলন আছে?
শপ.ওরিলি / প্রোডাক্ট / 807৮০596565১16১178.ডোর উত্স কোডটিতে একটি দুর্দান্ত সামান্য উদাহরণ রয়েছে। অধ্যায় 2 তালিকা দেখুন। এটি প্রায় উত্তর মত এখানে। আমি সোর্স কোডটি দেখানোর জন্য rdoc নিয়ে খেলেছি। আপনি নিজের ফাইল এক্সটেনশনকে my_code.rb এর মতো my_code.rb.txt এ কিছু করতে পারেন এবং তারপরে rdoc চালাতে পারেন। > rdoc my_code.rb.txt এরপরে এটি ক্লাস এবং মডিউলগুলির বিষয়ে কিছু যায় আসে না কারণ rdoc যেভাবেই এর জন্য এইচটিএমএল রেন্ডার করবে। এটি দিয়ে মজা করুন।
—
ডগলাস জি। অ্যালেন