مایکروسافت از یه ابزاری استفاده میکنه به اسم DocFx استفاده میکنه که کاملا مخصوص دات نت هست
ما چه چیزایی رو میتونیم بیایم به شکل داکیومنت در بیاریم؟
-.NET Assembly
یا فایل هایی مثل exe و dll البته نه این که مستقیما بخوایم اون ها رو بخونیم بلکه بر اساس متادیتاهایی که دارن اون ها داخل خروجی نمایش داده میشن
-xml comment
زمانی که ما یه متد یا کلاس داریم می نویسیم میتونیم براش یه سری توضیحات بنویسیم احتمالا ممکنه دیده باشید وقتی موس روی یک کلاس یا متد می برید یه توضیحاتی براش نوشته
برای این که بتونیم همچین چیزی رو ایجاد کنیم میتونیم از قابلیت xml comment استفاده کنیم که ساختارش به این شکل هست:
-مستندات api ای که نوشتی که با Swagger و OpenApi تعریف میکنی
-و از همه ساده تر و راحت تر فایل هایی که پسوند .md دارن یا اصطلاحا Markdown هستن
همه این ها میتونن در قالب html و pdf در خروجی نشون داده بشن
-.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 در خروجی نشون داده بشن
کانال توسعه دهندگان سی شارپ
ما چه چیزایی رو میتونیم بیایم به شکل داکیومنت در بیاریم؟ -.NET Assembly یا فایل هایی مثل exe و dll البته نه این که مستقیما بخوایم اون ها رو بخونیم بلکه بر اساس متادیتاهایی که دارن اون ها داخل خروجی نمایش داده میشن -xml comment زمانی که ما یه متد یا کلاس…
این بین اگر میخواید که بیشتر با کامنت نویسی xml آشنا بشید میتونید این ویدیویی که قبلا ضبط کردم رو ببینید:
https://www.aparat.com/v/wgb1y23
https://www.aparat.com/v/wgb1y23
آپارات - سرویس اشتراک ویدیو
آموزش مستند سازی حرفه ای کدها در سی شارپ
سلام دوستان بعد از مدت طولانی با یه ویدیو جذاب دیگه در خدمتتون هستیم و در این ویدیو یاد میگیرید که چجوری با استفاده از روش XmlComment برای متدها،کلاس ها و انواع ساختارهای داده ای مثل Enum ها یک روش کامنت(دیدگاه) گذاری حرفه ای روی کدهای خودتون در سی شارپ داشته…
برای این که بتونیم به صورت تستی روی سیستم خودمون اجراش کنیم نیازه چیکار کنیم؟
قبل از این که بخواید یه پروژه داکیومنت باهاش روی لوکال اجرا کنید باید این پیش نیازها رو داشته باشید:
-نصب داشتن دات نت( ترجیحا آخرین نسخه- از این لینک دانلود کنید)
-نصب داشتن Node js( از اینجا دانلود کنید)
-اگر هم میخواید مثل هر کدوم از مقالات داکیومنت مایکروسافت بتونید pdf شو دانلود کنید باید یه افزونه یا اکستنشن روی اون نصب کنید که اینم لینکش:
https://filzrev.github.io/docfx/docs/pdf.html
قبل از این که بخواید یه پروژه داکیومنت باهاش روی لوکال اجرا کنید باید این پیش نیازها رو داشته باشید:
-نصب داشتن دات نت( ترجیحا آخرین نسخه- از این لینک دانلود کنید)
-نصب داشتن Node js( از اینجا دانلود کنید)
-اگر هم میخواید مثل هر کدوم از مقالات داکیومنت مایکروسافت بتونید pdf شو دانلود کنید باید یه افزونه یا اکستنشن روی اون نصب کنید که اینم لینکش:
https://filzrev.github.io/docfx/docs/pdf.html
Microsoft
Download .NET (Linux, macOS, and Windows) | .NET
Free downloads for building and running .NET apps on Linux, macOS, and Windows. Runtimes, SDKs, and developer packs for .NET Framework, .NET, and ASP.NET.
برای ایجاد یک داکیومنت با docfx میتونیم یا از cmd استفاده کنیم یا از powershell یا از ترمینال هر ide که داخلش هستیم این رو وارد میکنیم:
این باعث نصب docfx میشه
در مرحله بعد این رو وارد میکنیم:
این کد باعث میشه تا ساختار اون پروژه مستندات رو بسازه
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_project) میسازه که شامل چیزای زیره:
docfx.json → فایل تنظیمات اصلی (اینجا میگی چه اسمبلی یا فایل Markdown استفاده بشه).
articles/ → جایی برای نوشتن مقالهها و توضیحات (Markdown).
api/ → جایی که بعداً DocFX اطلاعات اسمبلی (dll/exe + XML) رو به yml/مستندات تبدیل میکنه.
toc.yml → فهرست محتوا (Table of Contents).
index.md → صفحه اصلی سایت مستندات.
برای این که بتونیم کارمون رو اجرا کنیم این کد زیر رو وارد میکنیم:
این کد در واقع باعث میشه تا صفحات html تولید بشن یا به بیان بهتر پروژه build بشه
docfx docfx.json --serve
این کد در واقع باعث میشه تا صفحات html تولید بشن یا به بیان بهتر پروژه build بشه
دوستان اگر کسی کنارتون هست که مثل خودتون developer هست یا حتی اگر نباشه بازم سعی کنید در روز چیزی که یاد گرفتین رو توضیح بدید براش
خیلییی اثر میذاره روی یادگیری تون
حتی بازم اگر هیچ کسی نیست برا جی پی تی توضیح بدید تازه اون مسائلی که جا
انداختید رو هم براتون اصلاح میکنه
خیلی وقتا توی همین حرف زدنه یهو ایده ای به ذهنتون میرسه که برید انجامش بدید یا چیز جدیدتری رو یاد بگیرید
حتما امتحان کنید برا من که بی نظیر بود
خیلییی اثر میذاره روی یادگیری تون
حتی بازم اگر هیچ کسی نیست برا جی پی تی توضیح بدید تازه اون مسائلی که جا
انداختید رو هم براتون اصلاح میکنه
خیلی وقتا توی همین حرف زدنه یهو ایده ای به ذهنتون میرسه که برید انجامش بدید یا چیز جدیدتری رو یاد بگیرید
حتما امتحان کنید برا من که بی نظیر بود
درود آمن هوتب چهارم بر Gemini بزرگ،عزیز همه هوش مصنوعی ها
اگر یه جایی توی یه کد گیر کردید سریع ندید به جی پی تی بلکه بیاید بدینش به جمنای تا براتون اوکیش کنه
یه دو سه روز تصمیم گرفتم از جمنای استفاده کنم اگر جایی متوجه نشدم و حقیتا میتونم بگم بی نظیر بود
خیلی وقتا جی پی تی میاد لقمه رو دور سر آدم میچرخونه تا یه چیزی رو توضیح بده ولی جمنای میاد بخش به بخش واست توضیحش میده
البته ناگفته نمونه که من از مدل 2.5 flash استفاده کردم خوب بود وگرنه قطعا مدل2.5 Pro میتونست بهتر هم جواب بده
اگر یه جایی توی یه کد گیر کردید سریع ندید به جی پی تی بلکه بیاید بدینش به جمنای تا براتون اوکیش کنه
یه دو سه روز تصمیم گرفتم از جمنای استفاده کنم اگر جایی متوجه نشدم و حقیتا میتونم بگم بی نظیر بود
خیلی وقتا جی پی تی میاد لقمه رو دور سر آدم میچرخونه تا یه چیزی رو توضیح بده ولی جمنای میاد بخش به بخش واست توضیحش میده
البته ناگفته نمونه که من از مدل 2.5 flash استفاده کردم خوب بود وگرنه قطعا مدل2.5 Pro میتونست بهتر هم جواب بده
حتما همه شما موبونیوز رو میشناسید که مهدی شجاری صاحب این رسانه هست
باهاش مصاحبه ای شده که من این دو قسمت رو دیدم و واقعا خیلی جالب بود
یکی از نکته هایی که داخلش گفته شد این بود که حتی اگر یکمی خسته میشید یا ناامید باز توی همون وضعیت ادامه بدید تهش بالاخره اون اتفاق خوبه میوفته
حتی اگر روزهایی رو حوصله نداریم کد بزنیم نیم ساعت یا بیست دقیقه هم که شده روی اون موضوعه وقت بذاریم
باهاش مصاحبه ای شده که من این دو قسمت رو دیدم و واقعا خیلی جالب بود
یکی از نکته هایی که داخلش گفته شد این بود که حتی اگر یکمی خسته میشید یا ناامید باز توی همون وضعیت ادامه بدید تهش بالاخره اون اتفاق خوبه میوفته
حتی اگر روزهایی رو حوصله نداریم کد بزنیم نیم ساعت یا بیست دقیقه هم که شده روی اون موضوعه وقت بذاریم
👌1
Forwarded from TorhamDev | تورهام 😳
حالم دیگه داره بد میشه انقدر تو هر مزخرفی AI چپوندن. دیگه نمیشه IDE پیدا کرد که بدون AI باشه جز vim و بچههاش!
انگار آدمها مغز ندارن، و جدی یکسریها به این مرحله رسیدن گه دیگه مغز ندارن و همه چیز رو با AI حل میکنن.
AI -> autocomplite on steroids
یکسریها دیگه تصمیمات زندگیشون هم با AI میگیرن. میسه مغز برخی رو برداشت به جاش یک LLM گذاشت.
@TorhamDevCH
انگار آدمها مغز ندارن، و جدی یکسریها به این مرحله رسیدن گه دیگه مغز ندارن و همه چیز رو با AI حل میکنن.
AI -> autocomplite on steroids
یکسریها دیگه تصمیمات زندگیشون هم با AI میگیرن. میسه مغز برخی رو برداشت به جاش یک LLM گذاشت.
@TorhamDevCH
TorhamDev | تورهام 😳
حالم دیگه داره بد میشه انقدر تو هر مزخرفی AI چپوندن. دیگه نمیشه IDE پیدا کرد که بدون AI باشه جز vim و بچههاش! انگار آدمها مغز ندارن، و جدی یکسریها به این مرحله رسیدن گه دیگه مغز ندارن و همه چیز رو با AI حل میکنن. AI -> autocomplite on steroids یکسریها…
واقعا خودمم حالم بهم میخوره دیگه خیلی شورش رو در میارن
کار به جایی میرسه که میگن میخوای غذا بخوری؟
پرامپت بده به جمنای یا جی پی تی قاشق رو بزاره دهنت😂
کار به جایی میرسه که میگن میخوای غذا بخوری؟
پرامپت بده به جمنای یا جی پی تی قاشق رو بزاره دهنت😂
👍1
از وقتی تلگرام ویندوز روی سیستم حذفش کردم به شدت تمرکزم بالا رفته
چون به شدت چک میکردم موقع کار و فقط الان روی گوشیم تلگرام رو دارم
هر چیزی که باعث میشه تمرکز شما رو به هم بزنه بی رحمانه حذفش کنید
چون به شدت چک میکردم موقع کار و فقط الان روی گوشیم تلگرام رو دارم
هر چیزی که باعث میشه تمرکز شما رو به هم بزنه بی رحمانه حذفش کنید
2👍1
تجربه ثابت کرده هر کی با زبان های خانواده c شروع کرده از نظر دانش فنی و بیس کار قوی تره
در مقابل چیزایی مثل پایتون خیلی کار رو راحت کردن
کافیه یه کتابخونه با pip نصب کنی برا یه کار مثل رمز نگاری(Encryption) و ورودی ها بهش بدی خودش رمزنگاری با اون روش رمزنگاری(مثل SHA256) انجام میده
اما کافیه بخوای با سی شارپ انجام بدی😂
باید از فضای نام مخصوص رمزنگاری استفاده کنی بعد ورودی بگیری تبدیل کنه به آرایه از جنس byte بعد اون رو هش یا هر روش رمزنگاری دیگه ای روش انجام بدی و مجدد تبدیل کنی به آرایه و بعد هر جا خواستی استفاده کنی
به نظرم آدم وقتی یه چیزی رو عمیق متوجه میشه خیلی بعدا به کارش میاد
در مقابل چیزایی مثل پایتون خیلی کار رو راحت کردن
کافیه یه کتابخونه با pip نصب کنی برا یه کار مثل رمز نگاری(Encryption) و ورودی ها بهش بدی خودش رمزنگاری با اون روش رمزنگاری(مثل SHA256) انجام میده
اما کافیه بخوای با سی شارپ انجام بدی😂
باید از فضای نام مخصوص رمزنگاری استفاده کنی بعد ورودی بگیری تبدیل کنه به آرایه از جنس byte بعد اون رو هش یا هر روش رمزنگاری دیگه ای روش انجام بدی و مجدد تبدیل کنی به آرایه و بعد هر جا خواستی استفاده کنی
به نظرم آدم وقتی یه چیزی رو عمیق متوجه میشه خیلی بعدا به کارش میاد
👍3