فهرست مطالب:

چگونه می توانم نظرات را به XML در ویژوال استودیو اضافه کنم؟
چگونه می توانم نظرات را به XML در ویژوال استودیو اضافه کنم؟

تصویری: چگونه می توانم نظرات را به XML در ویژوال استودیو اضافه کنم؟

تصویری: چگونه می توانم نظرات را به XML در ویژوال استودیو اضافه کنم؟
تصویری: آموزش X ++ و ساختار داده ها در Microsoft Dynamics 365 Finance and Operations - Part 01 2024, ممکن است
Anonim

برای درج نظرات XML برای یک عنصر کد

  1. /// را در سی شارپ تایپ کنید، یا "" را در ویژوال بیسیک .
  2. از منوی ویرایش، IntelliSense > را انتخاب کنید درج نظر .
  3. از منوی زمینه یا کلیک راست روی عنصر کد یا درست بالای آن، Snippet > را انتخاب کنید درج نظر .

علاوه بر این، چگونه می توانم نظرات را در XML بنویسم؟

اگر شما می خواهید اظهار نظر از یک خط در XML کد، مکان نما خود را در ابتدای خطی که می خواهید وارد کنید اظهار نظر بیرون یک علامت کمتر از یک علامت تعجب و دو خط تیره تایپ کنید. مکان نما خود را به انتهای خط ببرید و سپس دو خط تیره به دنبال علامت بزرگتر از آن را تایپ کنید.

ممکن است یکی بپرسد، چگونه می توانم کد را در سی شارپ کامنت کنم؟ به کد آ اظهار نظر ، یک اسلش دو برابر رو به جلو و سپس علامت را تایپ کنید اظهار نظر . می توانید از این تکنیک برای اضافه کردن یک استفاده کنید اظهار نظر در خط خودش یا برای اضافه کردن a اظهار نظر پس از کد روی یک خط اغلب زمانی که شما کد ، ممکن است بخواهید اظهار نظر از یک بلوک کامل کد بیانیه.

دوم اینکه نظرات XML در سی شارپ چیست؟

یکی از اینهاست XML مستندات نظرات ، گاهی اوقات نامیده می شود نظرات XML ، که با یک اسلش سه گانه شروع می شود - ///. نظرات XML می توان از ویژگی IntelliSense ویژوال استودیو و کد VS برای نشان دادن اطلاعات مربوط به یک نوع یا عضو استفاده کرد. این اطلاعات از آنچه در مستندات کد خود قرار داده اید بدست می آید.

چگونه کد را مستند می کنید؟

بهترین روش ها برای نوشتن اسناد:

  1. شامل یک فایل README که شامل.
  2. ردیاب مشکل را برای دیگران مجاز کنید.
  3. یک مستندات API بنویسید.
  4. کد خود را مستند کنید
  5. از قراردادهای کدنویسی مانند سازماندهی فایل، نظرات، قراردادهای نامگذاری، شیوه های برنامه نویسی و غیره استفاده کنید.
  6. شامل اطلاعات برای مشارکت کنندگان.

توصیه شده: