PDA

View Full Version : مبتدی: روش اصولی کامنت نویسی



ozzy_mra
شنبه 04 اردیبهشت 1389, 08:41 صبح
اساتید محترم سلام
می خواستم ببینم روش صحیح و اصولی برای کامنت نویسی تو پروژه چیه و آیا روشی هست که از کامنت نوشته شده در برنامه یک فایل مجزای help ایجاد کنیم؟

razavi_university
شنبه 04 اردیبهشت 1389, 09:37 صبح
ساره ترین روش استفاده از نرم افزار ghostdoc و nDoc است.
ghostdoc برای تولید ساده توضیحات است. برای اینکار در ابتدای هر کلاس یا متد ctrl+D را برنید یک کامنت ساده برای آن ایجاد می کند، در آخر پروژه با nDoc می توانید کل این مستندات xml را به فرمت chm و قالب شبیه msdn خروجی بگیرید
سایت سازنده:
Ghost Doc : Simplify your XML Comments! (http://submain.com/products/ghostdoc.aspx)
NDoc Code Documentation Generator for .NET (http://ndoc.sourceforge.net/)


مطالب مرتبط در انجمن:
معرفی NDoc : ابزاری رایگان و کارآمد برای تولید مستندات (http://barnamenevis.org/forum/showpost.php?p=482893&postcount=220)
معرفی GhostDoc : ابزاری رایگان برای تولید اتوماتیک XML Comments در کدنویسی (http://barnamenevis.org/forum/showpost.php?p=483063)
توليد XML Document براي كد (http://www.barnamenevis.org/forum/showthread.php?t=104071)