উত্তর:
এমন কোনও অঞ্চল তৈরি করতে যেখানে আপনি ফাংশনটির জন্য একটি বিবরণ এবং ফাংশনের প্রতিটি প্যারামিটার নির্দিষ্ট করতে পারেন, আপনার ফাংশনের আগে লাইনে নিম্নলিখিতটি টাইপ করুন এবং হিট করুন Enter:
সি #: ///
ভিবি: '''
আপনি এই মন্তব্যে অন্তর্ভুক্ত করতে পারেন এমন কাঠামোগত সামগ্রীর আরও তথ্যের জন্য ডকুমেন্টেশন মন্তব্যগুলির জন্য প্রস্তাবিত ট্যাগগুলি দেখুন (সি # প্রোগ্রামিং গাইড) ।
আপনার যা দরকার তা হ'ল এক্সএমএল মন্তব্য - মূলত তারা এই বাক্য গঠনটি অনুসরণ করে (সোলমিড দ্বারা অস্পষ্টভাবে বর্ণিত):
সি শার্প
///<summary>
///This is a description of my function.
///</summary>
string myFunction() {
return "blah";
}ভিবি
'''<summary>
'''This is a description of my function.
'''</summary>
Function myFunction() As String
Return "blah"
End Function<c>text</c>- আপনি যে পাঠ্যটি কোড হিসাবে ইঙ্গিত করতে চান তা।
< সি > ট্যাগ আপনাকে বর্ণনার মধ্যে যে পাঠ্যটি কোড হিসাবে চিহ্নিত করা উচিত তা নির্দেশ করার একটি উপায় দেয়। কোড হিসাবে একাধিক লাইন চিহ্নিত করতে < কোড > ব্যবহার করুন ।
<code>content</code>- আপনি যে পাঠ্যটি চান সেটি কোড হিসাবে চিহ্নিত হয়েছে।
< কোড > ট্যাগ আপনাকে একাধিক লাইনকে কোড হিসাবে নির্দেশ করার একটি উপায় দেয়। কোনও বর্ণনার মধ্যে থাকা পাঠ্যকে কোড হিসাবে চিহ্নিত করা উচিত তা নির্দেশ করতে < সি > ব্যবহার করুন ।
<example>description</example>- কোড নমুনার একটি বিবরণ।
< উদাহরণ > ট্যাগ আপনাকে কোনও পদ্ধতি বা অন্যান্য গ্রন্থাগার সদস্য কীভাবে ব্যবহার করতে হয় তার একটি উদাহরণ নির্দিষ্ট করতে দেয়। এটি সাধারণত < কোড > ট্যাগ ব্যবহার করে জড়িত ।
<exception cref="member">description</exception>- ব্যতিক্রম একটি বিবরণ।
< ব্যতিক্রম > ট্যাগ আপনাকে নির্দিষ্ট করতে দেয় যে কোন ব্যতিক্রম ছোঁড়া যায়। এই ট্যাগটি পদ্ধতি, বৈশিষ্ট্য, ইভেন্ট এবং সূচকগুলির সংজ্ঞাতে প্রয়োগ করা যেতে পারে।
<include file='filename' path='tagpath[@name="id"]' />
< অন্তর্ভুক্ত > ট্যাগ আপনাকে অন্য কোনও ফাইলের মন্তব্যে উল্লেখ করতে দেয় যা আপনার উত্স কোডে প্রকার এবং সদস্যদের বর্ণনা করে। এটি সরাসরি আপনার উত্স কোড ফাইলে ডকুমেন্টেশন মন্তব্যগুলি রাখার বিকল্প। একটি পৃথক ফাইলে ডকুমেন্টেশন রেখে, আপনি উত্স কোড থেকে পৃথক করে ডকুমেন্টেশনে উত্স নিয়ন্ত্রণ প্রয়োগ করতে পারেন। একজনের সোর্স কোড ফাইলটি চেক আউট হতে পারে এবং অন্য কারও ডকুমেন্টেশন ফাইলটি চেক আউট করতে পারে। < অন্তর্ভুক্ত > ট্যাগটি এক্সএমএল এক্সপথ সিনট্যাক্স ব্যবহার করে। আপনার < অন্তর্ভুক্ত > ব্যবহারটি কাস্টমাইজ করার উপায়গুলির জন্য এক্সপথ ডকুমেন্টেশন দেখুন ।
<list type="bullet" | "number" | "table">
<listheader>
<term>term</term>
<description>description</description>
</listheader>
<item>
<term>term</term>
<description>description</description>
</item>
</list>< Listheader > ব্লকটি কোনও সারণী বা সংজ্ঞা তালিকার শিরোনাম সারিটি সংজ্ঞায়িত করতে ব্যবহৃত হয়। একটি সারণী সংজ্ঞায়িত করার সময়, আপনাকে কেবল শিরোনামে টার্মের জন্য একটি এন্ট্রি সরবরাহ করতে হবে। তালিকার প্রতিটি আইটেম একটি < আইটেম > ব্লক দিয়ে সুনির্দিষ্ট করা হয়েছে । সংজ্ঞা তালিকা তৈরি করার সময়, আপনাকে শব্দ এবং বর্ণন উভয়ই নির্দিষ্ট করতে হবে। তবে, একটি সারণী, বুলেটযুক্ত তালিকা বা সংখ্যাযুক্ত তালিকার জন্য আপনাকে কেবল বিবরণের জন্য একটি এন্ট্রি সরবরাহ করতে হবে। একটি তালিকা বা সারণীতে প্রয়োজনীয় হিসাবে অনেকগুলি < আইটেম > ব্লক থাকতে পারে।
<para>content</para>
< প্যারা > ট্যাগটি কোনও ট্যাগের ভিতরে যেমন < সংক্ষিপ্ত>> < মন্তব্য / > বা < রিটার্ন > ব্যবহারের জন্য হয় এবং আপনাকে পাঠ্যে কাঠামো যুক্ত করতে দেয়।
<param name="name">description</param>
পদ্ধতির ঘোষণার জন্য মন্তব্যে
< প্যারাম > ট্যাগটি ব্যবহার করা উচিত পদ্ধতির জন্য কোনও পরামিতি বর্ণনা করতে describe একাধিক পরামিতি নথি করতে, একাধিক < প্যারাম > ট্যাগ ব্যবহার করুন ।
<জন্য পাঠ্য PARAM > ট্যাগ IntelliSense, অবজেক্ট ব্রাউজার, এবং মধ্যে Code মন্তব্য ওয়েব প্রতিবেদন প্রদর্শন করা হবে।
<paramref name="name"/>
< প্যারামেফ > ট্যাগ আপনাকে নির্দেশ করার একটি উপায় দেয় যা কোড মন্তব্যগুলির মধ্যে একটি শব্দ উদাহরণস্বরূপ < সারসংক্ষেপ > বা < মন্তব্যসমূহ > ব্লকে একটি প্যারামিটারকে বোঝায়। এক্সএমএল ফাইলটি এই শব্দটিকে কিছু স্বতন্ত্র উপায়ে ফর্ম্যাট করতে প্রক্রিয়া করা যেতে পারে যেমন একটি গা a় বা তির্যক ফন্টের সাথে।
< permission cref="member">description</permission>
দ্য < অনুমতি > ট্যাগ আপনাকে কোনও সদস্যের অ্যাক্সেস ডকুমেন্ট করতে দেয়। PermissionSet বর্গ আপনাকে একটি সদস্যের অ্যাক্সেস নির্দিষ্ট করতে দেয়।
<remarks>description</remarks>
< সংলাপ > ট্যাগটি কোনও ধরণের তথ্য যোগ করতে < সারসংক্ষেপ>> সহ নির্দিষ্ট করা তথ্যের পরিপূরক হিসাবে ব্যবহৃত হয় । এই তথ্যটি অবজেক্ট ব্রাউজারে প্রদর্শিত হয়।
<returns>description</returns>
রিটার্নের মানটি বর্ণনা করতে কোনও পদ্ধতি ঘোষণার জন্য মন্তব্যে
< রিটার্ন > ট্যাগটি ব্যবহার করা উচিত।
<see cref="member"/>
< দেখুন > ট্যাগ আপনাকে পাঠ্যের মধ্যে থেকে একটি লিঙ্ক নির্দিষ্ট করতে দেয়। পাঠ্যটি এছাড়াও দেখুন বিভাগে রাখা উচিত তা বোঝাতে < salso > ব্যবহার করুন । কোড উপাদানগুলির জন্য ডকুমেন্টেশন পৃষ্ঠাগুলিতে অভ্যন্তরীণ হাইপারলিঙ্কগুলি তৈরি করতে ক্রেফ অ্যাট্রিবিউট ব্যবহার করুন।
<seealso cref="member"/>
< সিয়ালসো > ট্যাগটি আপনাকে পাঠ্যটি সুনির্দিষ্ট করতে দেয় যা আপনি দেখতে আরও দেখুন বিভাগে প্রদর্শিত হতে পারেন। পাঠ্যের মধ্যে থেকে একটি লিঙ্ক নির্দিষ্ট করতে < দেখুন > ব্যবহার করুন ।
<summary>description</summary>
< সংক্ষিপ্ত > ট্যাগটি কোনও প্রকার বা কোনও ধরণের সদস্যকে বর্ণনা করতে ব্যবহার করা উচিত। কোনও ধরণের বর্ণনায় পরিপূরক তথ্য যুক্ত করতে < মন্তব্যসমূহ > ব্যবহার করুন। কোড উপাদানগুলির জন্য ডকুমেন্টেশন পৃষ্ঠাগুলিতে অভ্যন্তরীণ হাইপারলিঙ্কগুলি তৈরি করতে স্যান্ডক্যাসলের মতো ডকুমেন্টেশন সরঞ্জামগুলি সক্ষম করতে ক্রেফ অ্যাট্রিবিউট ব্যবহার করুন। < সংক্ষিপ্ত > ট্যাগের পাঠ্যটি হ'ল ইন্টেলিজেন্স টাইপ সম্পর্কিত একমাত্র তথ্যের উত্স এবং এটি অবজেক্ট ব্রাউজারেও প্রদর্শিত হয়।
<typeparam name="name">description</typeparam>
কোনও টাইপ পরামিতি বর্ণনা করার জন্য জেনেরিক টাইপ বা পদ্ধতি ঘোষণার জন্য মন্তব্যে
< টাইপরাম > ট্যাগটি ব্যবহার করা উচিত। জেনেরিক টাইপ বা পদ্ধতির প্রতিটি ধরণের প্যারামিটারের জন্য একটি ট্যাগ যুক্ত করুন। < টাইপারাম > ট্যাগের জন্য পাঠ্যটি ইন্টেলিজেন্সে প্রদর্শিত হবে, অবজেক্ট ব্রাউজার কোড মন্তব্য ওয়েব রিপোর্ট।
<typeparamref name="name"/>
ডকুমেন্টেশন ফাইলের গ্রাহকদের শব্দের কিছু স্বতন্ত্র উপায়ে ফর্ম্যাট করতে সক্ষম করার জন্য এই ট্যাগটি ব্যবহার করুন, উদাহরণস্বরূপ ইটালিক্সে।
<value>property-description</value>
< মান > ট্যাগ আপনাকে কোনও সম্পত্তি প্রতিনিধিত্ব করে এমন মান বর্ণনা করতে দেয়। নোট করুন যে আপনি যখন ভিজ্যুয়াল স্টুডিও। নেট উন্নয়ন পরিবেশে কোড উইজার্ডের মাধ্যমে কোনও সম্পত্তি যুক্ত করবেন, তখন এটি নতুন সম্পত্তির জন্য < সারসংক্ষেপ > ট্যাগ যুক্ত করবে । তারপরে সম্পত্তিটি প্রতিনিধিত্ব করে এমন মানটি বর্ণনা করতে আপনাকে ম্যানুয়ালি একটি < মান > ট্যাগ যুক্ত করা উচিত ।
এক্সএমএল মন্তব্য করুন, এই মত
/// <summary>
/// This does something that is awesome
/// </summary>
public void doesSomethingAwesome() {}///<param name="paramName">Tralala</param>
মন্তব্যের প্রতিটি লাইন শুরু করতে /// ব্যবহার করুন এবং মন্তব্যে মেটা ডেটা রিডারের জন্য উপযুক্ত xML থাকতে হবে ।
///<summary>
/// this method says hello
///</summary>
public void SayHello();যদিও ব্যক্তিগতভাবে, আমি বিশ্বাস করি যে এই মন্তব্যগুলি সাধারণত বিপথগামী হয়, যদি না আপনি এমন ক্লাস গড়ে তুলছেন যেখানে কোডটি তার গ্রাহকরা পড়তে পারবেন না।
এগুলিকে এক্সএমএল মন্তব্য বলা হয় । তারা চিরকাল থেকেই ভিজ্যুয়াল স্টুডিওর একটি অংশ।
ঘোস্টডক ব্যবহার করে আপনি আপনার ডকুমেন্টেশন প্রক্রিয়াটিকে আরও সহজ করতে পারেন , ভিজ্যুয়াল স্টুডিওর জন্য একটি ফ্রি অ্যাড-ইন যা আপনার জন্য এক্সএমএল-ডক মন্তব্য তৈরি করে। আপনি যে পদ্ধতিতে / সম্পত্তি নথির চান তার উপর কেবল আপনার ক্যারেট রাখুন এবং সিটিআরএল-শিফট-ডি টিপুন।
আমার পোস্টগুলির একটি উদাহরণ এখানে ।
আশা করি এইটি কাজ করবে :)
সিএসের্পে, আপনি যদি তার পারমস দিয়ে পদ্ধতি / ফাংশনটির রূপরেখা তৈরি করেন, তবে আপনি যখন তিনটি ফরোয়ার্ড স্ল্যাশ যুক্ত করবেন তখন এটি সংক্ষিপ্তসার এবং পারম বিভাগটি স্বয়ংক্রিয়ভাবে উত্পন্ন করবে।
সুতরাং আমি এতে রেখেছি:
public string myMethod(string sImput1, int iInput2)
{
}আমি তারপরে তিনটি ///টিকে রেখেছিলাম এবং ভিজ্যুয়াল স্টুডিও আমাকে এটি দিয়েছে:
/// <summary>
///
/// </summary>
/// <param name="sImput1"></param>
/// <param name="iInput2"></param>
/// <returns></returns>
public string myMethod(string sImput1, int iInput2)
{
}এর মতো পদ্ধতিগুলি সংজ্ঞায়িত করুন এবং আপনার প্রয়োজনীয় সহায়তা পাবেন।
/// <summary>
/// Adds two numbers and returns the result
/// </summary>
/// <param name="first">first number to add</param>
/// <param name="second">second number to </param>
/// <returns></returns>
private int Add(int first, int second)
{
return first + second;
}পড়া http://msdn.microsoft.com/en-us/library/3260k4x7.aspx শুধু মন্তব্য উল্লেখ intellisense সাহায্যের মন্তব্য প্রদর্শিত হবে না।
এই সমস্ত অন্যান্য উত্তরগুলি বোঝায় তবে অসম্পূর্ণ। ভিজ্যুয়াল স্টুডিও এক্সএমএল মন্তব্যগুলি প্রক্রিয়া করবে তবে আপনাকে সেগুলি চালু করতে হবে। এটি কীভাবে করা যায় তা এখানে:
ইন্টেলিজেন্স আপনার উত্স কোডে প্রবেশ করা এক্সএমএল মন্তব্যগুলি ব্যবহার করবে তবে ভিজ্যুয়াল স্টুডিও বিকল্পগুলির মাধ্যমে আপনার এগুলি সক্ষম করতে হবে। যান Tools> Options> Text Editor। ভিজ্যুয়াল বেসিকের জন্য, Advanced> Generate XML documentation comments for '''সেটিংস সক্ষম করুন । সি # এর জন্য, Advanced> Generate XML documentation comments for ///সেটিংস সক্ষম করুন । Intelisense প্রবেশ করার সময় সংক্ষিপ্ত মন্তব্যগুলি ব্যবহার করবে। রেফারেন্সড প্রকল্পটি সংকলিত হওয়ার পরে তারা অন্যান্য প্রকল্পগুলি থেকে উপলব্ধ হবে।
তৈরি করতে বহিরাগত ডকুমেন্টেশন, আপনি মাধ্যমে একটি XML ফাইল তৈরি করা প্রয়োজন Project Settings> Build> XML documentation file:পথ যা নিয়ন্ত্রণ কম্পাইলার এর /docবিকল্প। আপনার একটি বাহ্যিক সরঞ্জামের প্রয়োজন হবে যা এক্সএমএল ফাইলটিকে ইনপুট হিসাবে গ্রহণ করবে এবং আপনার পছন্দসই আউটপুট ফর্ম্যাটগুলির মধ্যে ডকুমেন্টেশন তৈরি করবে।
সচেতন থাকুন যে এক্সএমএল ফাইল উত্পন্ন করা আপনার সংকলনের সময়টি লক্ষণীয়ভাবে বাড়িয়ে তুলতে পারে।
এছাড়াও ভিজ্যুয়াল স্টুডিও অ্যাড-ইন গোস্ট ডকটি আপনার ফাংশনটির নাম থেকে শিরোনাম মন্তব্য তৈরি এবং পূরণ করার চেষ্টা করবে।
সলমেডের সঠিক উত্তর রয়েছে। আরও তথ্যের জন্য আপনি এক্সএমএল মন্তব্যগুলিতে দেখতে পারেন ।