این روزها هر کسی رو که می بینم میخواد سی شارپ شروع کنه بهش میگم بره منابع انگلیسی ببینه
صد حیف که آدم وقتش پای بعضی دوره های آشغال ایرانی بگذرونه

با این وجود که خیلی وقته شروع کردم اما هنوز توی سی شارپ میلنگم و همزمان با asp دارم باز پایه قوی میکنم

اینم امروز میخوایم بررسیش کنیم ابزار docfx یه ابزار فوق العاده خفن که توی سی شارپ برای ساخت داکیومنت استفاده میشه

همه ما احتمالا دوست داشتیم یه بار هم که شده بیایم یه حالت داکیومنت طور بنویسیم و خب ابزارهای متفاوتی هست

به عنوان مثال شاید براتون جالب باشه که بدونید ویکی پدیا در اصل بر اساس " مدیا ویکی" ساخته شده که یه پروژه اوپن سورس و رایگان هست و به راحتی قابل نصب روی هاست های لینوکسی و ویندوزی هست
اگرچه قلق خاص خودش رو داره و نیاز هست ما بر اساس مستندات رسمی مدیا ویکی بریم جلو

اما اگر بخوایم با سی شارپ و دات نت این کار رو انجام بدیم چیکار باید کنیم؟

مایکروسافت از یه ابزاری استفاده میکنه به اسم DocFx استفاده میکنه که کاملا مخصوص دات نت هست

https://dotnet.github.io/docfx/
صفحه رسمی پروژه در گیت هاب

ما چه چیزایی رو میتونیم بیایم به شکل داکیومنت در بیاریم؟


-.NET Assembly

یا فایل هایی مثل exe و dll البته نه این که مستقیما بخوایم اون ها رو بخونیم بلکه بر اساس متادیتاهایی که دارن اون ها داخل خروجی نمایش داده میشن


-xml comment

زمانی که ما یه متد یا کلاس داریم می نویسیم میتونیم براش یه سری توضیحات بنویسیم احتمالا ممکنه دیده باشید وقتی موس روی یک کلاس یا متد می برید یه توضیحاتی براش نوشته

برای این که بتونیم همچین چیزی رو ایجاد کنیم میتونیم از قابلیت xml comment استفاده کنیم که ساختارش به این شکل هست:

///<summmary>
this is test method for display xml comment
///</summary>

private int Add(int a,int b)
{
return a+b;
}

-مستندات api ای که نوشتی که با Swagger و OpenApi تعریف میکنی


-و از همه ساده تر و راحت تر فایل هایی که پسوند .md دارن یا اصطلاحا Markdown هستن


همه این ها میتونن در قالب html و pdf در خروجی نشون داده بشن

این بین اگر میخواید که بیشتر با کامنت نویسی xml آشنا بشید میتونید این ویدیویی که قبلا ضبط کردم رو ببینید:

https://www.aparat.com/v/wgb1y23

برای این که بتونیم به صورت تستی روی سیستم خودمون اجراش کنیم نیازه چیکار کنیم؟

قبل از این که بخواید یه پروژه داکیومنت باهاش روی لوکال اجرا کنید باید این پیش نیازها رو داشته باشید:

-نصب داشتن دات نت( ترجیحا آخرین نسخه- از این لینک دانلود کنید)

-نصب داشتن Node js( از اینجا دانلود کنید)

-اگر هم میخواید مثل هر کدوم از مقالات داکیومنت مایکروسافت بتونید pdf شو دانلود کنید باید یه افزونه یا اکستنشن روی اون نصب کنید که اینم لینکش:
https://filzrev.github.io/docfx/docs/pdf.html

برای ایجاد یک داکیومنت با docfx میتونیم یا از cmd استفاده کنیم یا از powershell یا از ترمینال هر ide که داخلش هستیم این رو وارد میکنیم:

dotnet tool update -g docfx

این باعث نصب docfx میشه


در مرحله بعد این رو وارد میکنیم:

docfx init

این کد باعث میشه تا ساختار اون پروژه مستندات رو بسازه

بعد از اجرای docfx init چه اتفاقی میفته؟

DocFX یک پوشه (معمولاً به اسم docfx_project) می‌سازه که شامل چیزای زیره:

docfx.json → فایل تنظیمات اصلی (اینجا میگی چه اسمبلی یا فایل Markdown استفاده بشه).

articles/ → جایی برای نوشتن مقاله‌ها و توضیحات (Markdown).

api/ → جایی که بعداً DocFX اطلاعات اسمبلی (dll/exe + XML) رو به yml/مستندات تبدیل می‌کنه.

toc.yml → فهرست محتوا (Table of Contents).

index.md → صفحه اصلی سایت مستندات.

برای این که بتونیم کارمون رو اجرا کنیم این کد زیر رو وارد میکنیم:

docfx docfx.json --serve

این کد در واقع باعث میشه تا صفحات html تولید بشن یا به بیان بهتر پروژه build بشه

دوستان اگر کسی کنارتون هست که مثل خودتون developer هست یا حتی اگر نباشه بازم سعی کنید در روز چیزی که یاد گرفتین رو توضیح بدید براش

خیلییی اثر میذاره روی یادگیری تون

حتی بازم اگر هیچ کسی نیست برا جی پی تی توضیح بدید تازه اون مسائلی که جا
انداختید رو هم براتون اصلاح میکنه

خیلی وقتا توی همین حرف زدنه یهو ایده ای به ذهنتون میرسه که برید انجامش بدید یا چیز جدیدتری رو یاد بگیرید

حتما امتحان کنید برا من که بی نظیر بود

درود آمن هوتب چهارم بر Gemini بزرگ،عزیز همه هوش مصنوعی ها

اگر یه جایی توی یه کد گیر کردید سریع ندید به جی پی تی بلکه بیاید بدینش به جمنای تا براتون اوکیش کنه

یه دو سه روز تصمیم گرفتم از جمنای استفاده کنم اگر جایی متوجه نشدم و حقیتا میتونم بگم بی نظیر بود

خیلی وقتا جی پی تی میاد لقمه رو دور سر آدم میچرخونه تا یه چیزی رو توضیح بده ولی جمنای میاد بخش به بخش واست توضیحش میده

البته ناگفته نمونه که من از مدل 2.5 flash استفاده کردم خوب بود وگرنه قطعا مدل2.5 Pro میتونست بهتر هم جواب بده

حتما همه شما موبونیوز رو میشناسید که مهدی شجاری صاحب این رسانه هست

باهاش مصاحبه ای شده که من این دو قسمت رو دیدم و واقعا خیلی جالب بود

یکی از نکته هایی که داخلش گفته شد این بود که حتی اگر یکمی خسته میشید یا ناامید باز توی همون وضعیت ادامه بدید تهش بالاخره اون اتفاق خوبه میوفته

حتی اگر روزهایی رو حوصله نداریم کد بزنیم نیم ساعت یا بیست دقیقه هم که شده روی اون موضوعه وقت بذاریم

حالم دیگه داره بد میشه انقدر تو هر مزخرفی AI چپوندن. دیگه نمیشه IDE پیدا کرد که بدون AI باشه جز vim و بچه‌هاش!
انگار آدم‌ها مغز ندارن، و جدی یک‌سری‌ها به این مرحله رسیدن گه دیگه مغز ندارن و همه چیز رو با AI حل میکنن.
AI -> autocomplite on steroids

یکسری‌ها دیگه تصمیمات زندگیشون هم با AI میگیرن. میسه مغز برخی رو برداشت به جاش یک LLM گذاشت.

@TorhamDevCH

واقعا خودمم حالم بهم میخوره دیگه خیلی شورش رو در میارن
کار به جایی میرسه که میگن میخوای غذا بخوری؟
پرامپت بده به جمنای یا جی پی تی قاشق رو بزاره دهنت😂

از وقتی تلگرام ویندوز روی سیستم حذفش کردم به شدت تمرکزم بالا رفته
چون به شدت چک میکردم موقع کار و فقط الان روی گوشیم تلگرام رو دارم
هر چیزی که باعث میشه تمرکز شما رو به هم بزنه بی رحمانه حذفش کنید