دهم: NDoc
ابزاري كه ميخواهم معرفي كنم فقط به كار برنامهنويسان حرفهاي ميآيد. برنامه NDoc به شما كمك ميكند براي نرمافزاري كه نوشتهايد يك سند راهنماي برنامهنويسي (Help Documentation) بسازيد. اين سند به چه دردي ميخورد؟ اين راهنما در چند سناريوي مختلف مفيد واقع ميشود. مهمترين كاربرد NDoc هنگامي است كه در يك تيم برنامهنويسي كار ميكنيد و بايد كارهاي خود را مستند كنيد و لازم است مستندات برنامهاي را كه نوشتهايد به مدير خود ارائه دهيد تا او بتواند با تكيه براين مستند از سازوكار و ساختار نرمافزار شما سردربياورد و در صورت لزوم برنامهنويس ديگري را براي كمك به روند پيشرفت پروژه و خود شما، به خدمت بگيرد.
نمايي از NDoc
اگر سورس كد شما فاقد راهنما باشد، هيچكس، جز خودتان، از آن سردرنميآورد و بدتر از آن، حتي خود شما نيز ممكن است بعد از چند ماه اصلا فراموش كنيد كه ساختار دروني يك قطعه از كدي كه نوشتهبوديد چگونه بود. اين مشكل بهويژه هنگامي بروز ميكند كه مدت چند ماه بخش خاصي از نرمافزار خود را دستكاري نكردهايد.
در تمام اين حالتها داشتن يك سند راهنما مفيد واقع ميشود. براي اين منظور NDoc از قابليت مستندسازي با استفاده از XML در زبان سي شارپ كمك ميگيرد. البته اگر با ويژوال بيسيك داتنت كارميكنيد، ميتوانيد با استفاده از يك add-on همين قابليت را به محيط IDE ويژوال بيسيك اضافه كنيد.
براي آشنايي با متدولوژي مستندسازي با استفاده از XML بايد به راهنماي برنامهنويسي با سيشارپ در MSDN مراجعه كنيد. اطلاعات بيشتر و نيز لينك add-on مذكور در سايت NDoc وجود دارد. پس از مستندسازي كد با استفاده از XML ميتوانيد از NDoc براي توليد فايل Help از نوع chm يا با فرمت HTML (به سبك MSDN) يا به سبك نسخه آنلاين MSDN استفاده كنيد. برنامه NDoc را به صورت رايگان ميتوانيد از نشاني ndoc.sourceforge.net دريافت كنيد.