Helixoft VSdocman v12.0.9208.32632 – Professional .NET Documentation Made Easy
تولید مستندات API از کد منبع Visual Studio
Specification
| Feature | API-Docs |
|---|
| Technology | .Net Core, .Net Framework |
|---|
| Platform | Windows |
|---|
توضیحات:
کامپوننت VSdocman ابزاری است که برای افزودن توضیحات به کد و تولید مستندات در محیط Visual Studio برای پروژه‌های C# و VB.NET مورد استفاده قرار می‌گیرد. این ابزار مستندات را به طور مستقیم از کد منبع (Source Code) استخراج می‌کند و به همین علت، نیازی به وجود اسمبلی‌های کامپایل شده (compiled assemblies) ندارد؛ همچنین از انواع پروژه‌ها نظیر کتابخانه‌های کلاسی (Class Libraries)، برنامه‌های کاربردی، برنامه‌های تحت وب، اندروید، پروژه‌های چند سکویی (چند پلتفرمی)، WPF، WCF و Silverlight پشتیبانی می‌کند.
توسعه دهندگان در این زمینه می‌توانند مستندات API را در قالب‌های متنوعی از جمله CHM، HTML، DOCX، PDF، Markdown، Microsoft Help Viewer، MS Help 2، XML و فرمت‌های متنی، به صورت سفارشی تولید کنند. این ابزار امکاناتاتی را در اختیار کاربران قرار می‌دهد که بتوان از طریق آنها، خروجی نهایی را شخصی سازی کرد؛ از جمله این امکانات می‌توان به مواردی چون تمپلیت‌ها، متن‌های بومی سازی شده، استایل‌های سازمانی، فهرست مطالب، قابلیت جستجو، نمایه سازی (Index) و افزودن مباحثی فراتر از API اشاره نمود. ابزار VSdocman همچنین در ایجاد و مدیریت توضیحات XML در محیط Visual Studio نقش مؤثری دارد.
این ابزار امکان درج توضیحات پیش‌فرض و ارائه یک ویرایشگر توضیحات با قابلیت مشاهده هم زمان نتیجه تحت عنوان WYSIWYG را فراهم می‌کند. همچنین وظایف دیگری مانند تولید اطلاعات برای IntelliSense و Object Browser، ایجاد راهنمای F1 و عملکرد در هر دو حالت رابط گرافیکی (GUI) و خط فرمان را نیز انجام می‌دهد.
ویژگی ها:
- امکان تولید مستندات API برای C# و VB.NET
- قابلیت استخراج اطلاعات بر اساس کد منبع (بدون نیاز به اسمبلی‌های کامپایل شده)
- امکان گرفتن خروجی در فرمت‌های CHM، HTML، DOCX، PDF، Markdown، Help Viewer و XML
- دارای فرمت‌های خروجی با قابلیت سفارشی سازی و امکان اعمال استایل‌های سازمانی
- امکان پشتیبانی از توضیحات مستند سازی استاندارد XML
- دارای ویرایشگر توضیحات با قابلیت مشاهده هم زمان نتیجه (WYSIWYG) در محیط Visual Studio
- امکان پشتیبانی از IntelliSense، Object Browser و تولید راهنمای F1
- قابلیت اجرا در حالت‌های رابط گرافیکی (GUI) و خط فرمان (Command-line)
مناسب برای:
منایب برای توسعه‌دهندگان Visual Studio که نیاز به تولید مستندات API و توضیحات XML قابل نگهداری برای اجرا در پروژه‌های #C یا VB.NET دارند.
سوالات متداول:
کدام نسخه‌های Visual Studio در این ابزار پشتیبانی می‌شوند؟
در صفحات محصول، پشتیبانی از نسخه‌های Visual Studio 2022، 2019 و 2017 ذکر شده است و یادداشت‌های انتشار (Release Notes) نیز پشتیبانی از Visual Studio 2026 را به این مجموعه اضافه کرده‌اند.
ابزار VSdocman چه فرمت‌هایی از مستندات را می‌تواند تولید کند؟
این ابزار می‌تواند فرمت‌های CHM، HTML، DOCX، PDF، Markdown، Microsoft Help Viewer، MS Help 2، XML و فرمت‌های متنی سفارشی را تولید کند.
آیا VSdocman به اسمبلی‌های کامپایل شده (Compiled Assemblies) نیاز دارد؟
خیر. مستندات به طور مستقیم از طریق کد منبع (Source Code) استخراج می‌شوند؛ این ویژگی برای پروژه‌هایی کاربرد دارد که در آنها اسمبلی‌های کامپایل شده در دسترس نیستند.
آیا این ابزار می‌تواتد در نوشتن توضیحات مستند سازی XML کاربرد داشته باشد؟
بله. VSdocman می‌تواند توضیحات XML پیش فرض را درج کند و یک ویرایشگر توضیحات با قابلیت مشاهده هم زمان خروجی تحت عنوان WYSIWYG را برای ویرایش توضیحات در محیط Visual Studio ارائه دهد.
Reviews
Clear filtersThere are no reviews yet.