আমি ভাবছিলাম ভিজ্যুয়াল স্টুডিওতে অটো জেনারেশন ফাংশন শিরোনাম তৈরি করার কোনও উপায় আছে (আশাকরি কীবোর্ড শর্টকাট)।
উদাহরণ:
Private Function Foo(ByVal param1 As String, ByVal param2 As Integer)
এবং এটি স্বয়ংক্রিয়ভাবে এমন কিছু হয়ে উঠবে ...
'----------------------------------
'Pre:
'Post:
'Author:
'Date:
'Param1 (String):
'Param2 (Integer):
'Summary:
Private Function Foo(ByVal param1 As String, ByVal param2 As Integer)
উত্তর:
এটি "তিনটি একক মন্তব্য-চিহ্নিতকারী" করুন
সি # তে এটি ///
যা ডিফল্ট হিসাবে spits:
/// <summary>
///
/// </summary>
/// <returns></returns>
ঘোস্টডক !
ফাংশনে ডান-ক্লিক করুন, "এটি নথি করুন" এবং নির্বাচন করুন
private bool FindTheFoo(int numberOfFoos)
হয়ে যায়
/// <summary>
/// Finds the foo.
/// </summary>
/// <param name="numberOfFoos">The number of foos.</param>
/// <returns></returns>
private bool FindTheFoo(int numberOfFoos)
(হ্যাঁ, এটি সমস্ত স্বয়ংক্রিয়ভাবে তৈরি)।
এটিতে সি #, ভিবি.এনইটি এবং সি / সি ++ এর জন্য সমর্থন রয়েছে। এটি ডিফল্ট ম্যাপ প্রতি Ctrl+ + Shift+ +D ।
মনে রাখবেন: ডকুমেন্টেশনে আপনার পদ্ধতির স্বাক্ষরের বাইরে তথ্য যুক্ত করা উচিত। কেবলমাত্র স্বয়ংক্রিয়ভাবে তৈরি ডকুমেন্টেশন দিয়ে থামবেন না। এই জাতীয় একটি সরঞ্জামের মান হ'ল এটি স্বয়ংক্রিয়ভাবে ডকুমেন্টেশন উত্পন্ন করে যে পদ্ধতি স্বাক্ষর থেকে বের করা যেতে পারে, সুতরাং আপনার যুক্ত হওয়া কোনও তথ্যই নতুন তথ্য হওয়া উচিত ।
বলা হচ্ছে, আমি ব্যক্তিগতভাবে পছন্দ করি যখন পদ্ধতিগুলি সম্পূর্ণ স্ব-দস্তাবেজ হয় তবে কখনও কখনও আপনার কাছে কোডিং-স্ট্যান্ডার্ড থাকে যা ডকুমেন্টের বাইরের আদেশ দেয় এবং তারপরে এই জাতীয় সরঞ্জাম আপনাকে অনেক বেশি ব্র্যান্ডিনড টাইপিং সাশ্রয় করতে পারে।
///
পদ্ধতি বর্ণনা মন্তব্য ব্লক পাওয়ার শর্টকাট is তবে নিশ্চিত হয়ে নিন যে আপনি এটি যুক্ত করার আগে ফাংশনের নাম এবং স্বাক্ষর লিখেছেন। প্রথমে ফাংশনের নাম এবং স্বাক্ষর লিখুন।
তারপরে ফাংশন নামের উপরে শুধু টাইপ করুন ///
এবং আপনি এটি স্বয়ংক্রিয়ভাবে পাবেন
ভিজ্যুয়াল অ্যাসিস্টের একটি দুর্দান্ত সমাধানও রয়েছে এবং এটি অত্যন্ত সাশ্রয়ী মূল্যের।
অক্সিজেন-স্টাইলের মন্তব্য তৈরি করার জন্য এটি টুইট করার পরে, এই দুটি ক্লিকটি তৈরি করবে -
/**
* Method: FindTheFoo
* FullName: FindTheFoo
* Access: private
* Qualifier:
* @param int numberOfFoos
* @return bool
*/
private bool FindTheFoo(int numberOfFoos)
{
}
(ডিফল্ট সেটিংসের আওতায় এটি কিছুটা আলাদা)
সম্পাদনা করুন: 'ডকুমেন্ট পদ্ধতি' পাঠ্যটি কাস্টমাইজ করার উপায়টি ভ্যাসিস্টএক্স-> ভিজ্যুয়াল সহায়তা বিকল্পসমূহ-> পরামর্শসমূহের অধীনে, 'ভিএ স্নিপেটস সম্পাদনা করুন', ভাষা: সি ++, টাইপ: রিফ্যাক্টরিং নির্বাচন করুন, তারপরে 'নথি পদ্ধতি' এ যান এবং কাস্টমাইজ করুন। উপরের উদাহরণটি উত্পন্ন:
সাধারণত আপনি ভিজ্যুয়াল স্টুডিওটি নিজেরাই তৈরি করে যদি আপনি মন্তব্য করতে পছন্দ করেন (মেথড, ক্লাস) এর উপরে তিনটি একক মন্তব্য-মার্কার যুক্ত করেন।
সি # তে এটি হবে ///।
যদি ভিজ্যুয়াল স্টুডিও এটি না করে তবে আপনি এটি সক্ষম করতে পারবেন
বিকল্প-> পাঠ্য সম্পাদক-> সি # -> উন্নত
এবং পরীক্ষা করুন
/// এর জন্য এক্সএমএল ডকুমেন্টেশন মন্তব্য তৈরি করুন
আপনি যে কোনও লাইন সন্নিবেশ করানোর জন্য কোড স্নিপেট ব্যবহার করতে পারেন।
এছাড়াও, যদি আপনি ফাংশন শিরোনামের উপরে লাইনটিতে তিনটি একক উদ্ধৃতি চিহ্ন ('' ') টাইপ করেন তবে এটি এক্সএমএল শিরোনাম টেম্পলেটটি সন্নিবেশ করবে যা আপনি পূরণ করতে পারবেন।
এই এক্সএমএল মন্তব্যগুলি ডকুমেন্টেশন সফ্টওয়্যার দ্বারা ব্যাখ্যা করা যেতে পারে এবং সেগুলি বিল্ড আউটপুটে একটি એસেম্বলি.এক্সএমএল ফাইল হিসাবে অন্তর্ভুক্ত করা হয়। যদি আপনি সেই এক্সএমএল ফাইলটি ডিএলএল এবং ডিএলএলটিকে অন্য কোনও প্রকল্পে উল্লেখ করেন তবে সেই মন্তব্যগুলি ইন্টেলিজেন্সে উপলব্ধ হবে।
আমি টোডোক নামে একটি ওপেন-সোর্স প্রকল্পে কাজ করছি যা কোনও ফাইল সংরক্ষণ করার সময় শব্দগুলির বিশ্লেষণ করে সঠিক ডকুমেন্টেশন আউটপুট স্বয়ংক্রিয়ভাবে তৈরি করতে পারে। এটি বিদ্যমান মন্তব্যগুলিকে সম্মান করে এবং সত্যই দ্রুত এবং তরল।