এক Xcode 5 এর নতুন বৈশিষ্ট্যগুলি একটি বিশেষ মন্তব্য সিনট্যাক্স সঙ্গে আপনার নিজের কোড নথি করার দক্ষতা। বিন্যাস doxygen অনুরূপ, কিন্তু শুধুমাত্র একটি উপসেট সমর্থন করার জন্য উপস্থিত যারা বৈশিষ্ট্য ।
কোন আদেশগুলি সমর্থিত, এবং কোনটি নয়?
তাদের ব্যবহারের কোনওটি কি অক্সিজেন থেকে পৃথক?
উত্তর:
এক্সকোড 5.0.2 হিসাবে আমি খুঁজে পেয়েছি সমস্ত বিকল্পের একটি উদাহরণ এখানে
এটি এই কোডটি দিয়ে তৈরি হয়েছিল:
/** First line text.
Putting \\n doesn't create a new line.\n One way to create a newline is by making sure nothing is on that line. Not even a single space character!
@a Italic text @em with @@a or @@em.
@b Bold text with @@b.
@p Typewritter font @c with @@p or @@c.
Backslashes and must be escaped: C:\\foo.
And so do @@ signs: user@@example.com
Some more text.
@brief brief text
@attention attention text
@author author text
@bug bug text
@copyright copyright text
@date date text
@invariant invariant text
@note note text
@post post text
@pre pre text
@remarks remarks text
@sa sa text
@see see text
@since since text
@todo todo text
@version version text
@warning warning text
@result result text
@return return text
@returns returns text
@code
// code text
while (someCondition) {
NSLog(@"Hello");
doSomething();
}@endcode
Last line text.
@param param param text
@tparam tparam tparam text
*/
- (void)myMethod {}মন্তব্য:
/** block */, /*! block */অথবা সঙ্গে পূর্বে সমাধান ///বা //!।@( হেডারডোক স্টাইল) বা \( ডক্সিকান স্টাইল) উপসর্গের সাথে কাজ করে। (অর্থাত @bএবং \bউভয়ই একই কাজ করে))@propertyপাঠ্য।) তারা সঙ্গে, পরে আসতে পারে একই লাইনে, /*!<, /**<, //!<, ///<।@returns।
এটি সংক্ষিপ্ত পাঠ্যটি প্রদর্শন করবে (বিন্যাস ছাড়াই); যদি কোনও সংক্ষিপ্ত পাঠ্য উপস্থিত না থাকে, তবে এটি প্রথম @ ব্লক পর্যন্ত সমস্ত পাঠ্যকে একত্রে প্রদর্শন করবে; যদি কোনওটিই উপস্থিত না থাকে (যেমন আপনি @ পুনর্নির্মাণের সাথে শুরু করেন), তবে এটি সমস্ত @ কম্যান্ডগুলি সরিয়ে সমস্ত পাঠ্যকে এক করে দেবে।
(প্রথম স্ক্রিনশট দেখুন।)
যেহেতু এক্সকোড 5-এ কমান্ডগুলি ডক্সিজেনের সাথে সামঞ্জস্যপূর্ণ, তাই আপনি ডকুমেন্টেশন ফাইলগুলি তৈরি করতে ডক্সিজেন ডাউনলোড এবং ব্যবহার করতে পারেন।
ডক্সিজেনের সাধারণ পরিচিতির জন্য এবং কীভাবে উদ্দেশ্য-সি কোড নথিভুক্ত করবেন, এই পৃষ্ঠাটি একটি ভাল সংস্থান হিসাবে মনে হচ্ছে।
সমর্থিত কয়েকটি কমান্ডের বিবরণ:
@brief: বর্ণনা ক্ষেত্রের শুরুতে পাঠ্য সন্নিবেশ করানো হবে এবং কোড সম্পূর্ণ হওয়ার সময় প্রদর্শিত হবে এমন একমাত্র পাঠ্য।নিম্নলিখিতগুলি কাজ করে না:
\n: একটি নতুন লাইন তৈরি করে না। একটি নতুন লাইন তৈরির একটি উপায় হ'ল লাইনটিতে কিছুই নেই তা নিশ্চিত করা। একক স্থানের চরিত্রও নয়!\exampleনিম্নলিখিতগুলি সমর্থিত নয় (এগুলি গা dark় সবুজতে দেখা যায় না):
অ্যাপল সংরক্ষিত কীওয়ার্ড হিসাবে উপস্থিত বলে মনে হয় যা কেবলমাত্র তাদের ডকুমেন্টেশনে কাজ করে। যদিও তারা গা dark় সবুজতে দেখা যায়, দেখে মনে হচ্ছে আমরা এগুলি অ্যাপলের মতো ব্যবহার করতে পারি না। আপনি অ্যাভিসিপচারআউটপুট। H এর মতো ফাইলগুলিতে অ্যাপলের ব্যবহারের উদাহরণ দেখতে পাচ্ছেন।
এখানে সেই কয়েকটি কীওয়ার্ডের তালিকা রয়েছে:
সর্বোপরি, কীওয়ার্ডটি বিবরণ ক্ষেত্রে (যেমন @ বিবাদ) একটি নতুন লাইন তৈরি করবে। দুর্ভাগ্যক্রমে, মূলশব্দ এবং এরপরে যে কোনও পাঠ্য তাড়াতাড়ি সহায়তায় প্রদর্শিত হবে না (যেমন @ ক্লাস)।
@cহিসাবে, টাইপরাইটার টেক্সট পরবর্তী শব্দের প্রদর্শন করে Returns an @c NSString or @c nil.।
-[CADisplayLink addToRunLoop:forMode:], বর্ণনায় অন্যান্য শ্রেণীর নামযুক্ত লিঙ্কগুলি অন্তর্ভুক্ত রয়েছে (তবে আমি মনে করি ওয়েব-মুখী ইউআরএলগুলিও দরকারী হবে)।
সুইফট ২.০ নিম্নলিখিত সিনট্যাক্স ব্যবহার করে:
/**
Squares a number.
- parameter parameterName: number The number to square.
- returns: The number squared.
*/@paramএখন কেমন আছে তা লক্ষ্য করুন - parameter।
আপনি এখন আপনার ডকুমেন্টেশনে বুলেটগুলি অন্তর্ভুক্ত করতে পারেন:
/**
- square(5) = 25
- square(10) = 100
*/Senseful:
আপনার ডকুমেন্টেশনের সর্বশেষ পরিবর্তনগুলি উপস্থিত হওয়ার আগে আপনাকে আপনার প্রকল্পটি তৈরি করতে হবে।
কখনও কখনও এটি আমার পক্ষে যথেষ্ট ছিল না। এক্সকোড বন্ধ করে দেওয়া এবং প্রজেক্টটি ব্যাক আপ করা সাধারণত সেই ক্ষেত্রে প্রতিকার দেয়।
আমি .h ফাইল এবং .m ফাইলগুলিতেও পৃথক ফলাফল পাচ্ছি। যখন নথির মন্তব্যগুলি শিরোনাম ফাইলে থাকে তখন আমি নতুন লাইন পেতে পারি না।
বেশিরভাগ ফরম্যাটিং পরিবর্তন হয়েছে সুইফট ২.০ এর জন্য (Xcode7 73 হিসাবে, ß4-এও সত্য)
পরিবর্তে :param: thing description of thing
(যেমন এটি সুইফট ১.২ এ ছিল)
এটা এখন - parameter thing: description of thing
বেশিরভাগ কীওয়ার্ড এর - [keyword]: [description]পরিবর্তে প্রতিস্থাপন করা হয়েছে :[keyword]: [description]। বর্তমানে কীওয়ার্ড যে কাজ করে না একটি তালিকা অন্তর্ভুক্ত, abstract, discussion, brief, pre, post, sa, see, availability, class, deprecated, method, property, protocol, related, ref।