بایگانی

Archive for the ‘روبی’ Category

yard در روبی

دسامبر 4, 2012 بیان دیدگاه

در زبان‌های مختلف ابزارهای مختلفی برای تولید مستندات از داخل کدها وجود دارد.

در زبان روبی ابزاری که برای این‌کار استفاده می‌شود rdoc است. وقتی که یک کتابخانه یا یک gem را نصب می‌کنید، rdoc آن نیز نصب می‌شود.

ابزار پیش‌فرض برای دیدن مستندات rdoc، همان gem است که با دستور زیر می‌توانید به آدرس 127.0.0.1:8808 در مرورگر بروید و مستندات gemهای نصب شده را ببینید.

gem server

اما به دلیل خوش‌دست نبودن و مشکل جستجو در سرور پیش‌فرض مستندات gem، من پیشنهاد می‌کنم از yard استفاده کنید. برای نصب yard از دستور زیر استفاده کنید.

gem install yard

توجه کنید که yard یک تولیدکننده (generator) مستندات مثل rdoc است. اما نکتهٔ قابل توجه آن سازگار بودن با نحوه نوشتار rdoc است. در yard شما می‌توانید از markdown نیز استفاده کنید در صورتی که در rdoc نمی‌توان استفاده کرد.

yard از redcarpet برای parse کردن markdown استفاده می‌کند. بنابراین آن را نیز باید نصب کنید:

gem install redcarpet

در آخر اگر نیاز به تولید تمام rdocهای gemها بودید از دستور زیر استفاده کنید:

gem rdoc –all

برای استفاده از سرور yard از دستور زیر استفاده کنید و به‌مانند gem server برای دیدن مستندات به آدرس 127.0.0.1:8808 مرورگر خود بروید:

yard server –gems

%d وب‌نوشت‌نویس این را دوست دارند: