‫ساده‌سازی درک کد با نمودارهای Mermaid و CodeRush

دیوید مک‌کارتر در dotNetTips.com، روشی برای بهبود خوانایی کد با استفاده از نمودارهای Mermaid و ابزار CodeRush از DevExpress را شرح می‌دهد. این روش شامل جاسازی نمودارهای Mermaid به عنوان تصاویر در کد منبع برای مستندسازی بصری جریان و رفتار متدها است. ابزار CodeRush امکان جاسازی تصاویر را به طور مستقیم در کد فراهم می‌کند، که در ابتدا برای برندسازی استفاده می‌شد اما اکنون برای مستندسازی پیچیدگی‌های کد به کار می‌رود. مک‌کارتر از Copilot برای تولید سینتکس نمودارهای Mermaid استفاده کرده است، که یک زبان نمودارسازی متنی و سبک است و به راحتی در فایل‌های Markdown و README قابل استفاده است. به عنوان مثال، متد FileProcessor.DeleteFiles() در پروژه DotNetTips.Spargine به دلیل داشتن مسیرهای اجرایی متعدد، رویدادهای پردازش فایل و پشتیبانی از لغو عملیات، برای ایجاد نمودار جریان انتخاب شده است. Copilot با یک دستور ساده، سینتکس کامل نمودار جریان را تولید کرد. نمودار جریان تولید شده شامل گام‌هایی مانند بررسی Null بودن فایل‌ها، حذف فایل‌های تکراری، بررسی لغو عملیات، بررسی وجود فایل، حذف ویژگی فقط خواندنی، اندازه‌گیری عملکرد و مدیریت خطاها است. این نمودار به درک بهتر منطق پیچیده متد کمک می‌کند. استفاده از نمودارهای Mermaid و CodeRush می‌تواند به توسعه‌دهندگان .NET کمک کند تا کد خود را به طور موثرتری مستندسازی کنند و درک آن را برای دیگران (و خودشان در آینده) آسان‌تر سازند.