জাভাডক এ @see এর ব্যবহার?

110

@seeজাভাডক্সের সাথে কাজ করার সময় আমি কখন ব্যবহার করব? এর ব্যবহার কী?

উদাহরণস্বরূপ, যদি MethodAকল MethodBতারপর আমি দিতে হবে না @seeযে MethodBএর javadoc এবং রেফারেন্স MethodAকারণ এটি কি বলা হয় যে, অথবা আমি একটি রেফারেন্স দিতে হবে না MethodBথেকে MethodAকারণ এটি ডাকছে। আমি @seeওরাকল ওয়েবসাইটটিতে স্টাফটি পড়েছি এবং এটি আমার কাছে অবিশ্বাস্যরূপে অস্পষ্ট বলে মনে হয়েছে, এটি বলছে এর অর্থ "আরও দেখুন" তবে এর অর্থ কী না!

java methods javadoc

— জেফ
সূত্র

4

করা @seeমধ্যে MethodBএর javadoc এবং রেফারেন্স MethodAকারণ এটি কি বলা হয় যে -> কিভাবে কি কখনো সম্ভব হবে সব পদ্ধতি যা আপনার পদ্ধতি এক কল জানেন কিভাবে? এমনকি যদি এটি সম্ভব হয় (কেবল একবার ব্যবহৃত ব্যক্তিগত পদ্ধতি বলুন) কলি থেকে কলারের সাথে সংযুক্ত হওয়া কমপক্ষে অদ্ভুত শোনায় ...

— Mr_and_Mrs_D

1

এটি ইংরাজীতে সাধারণত যা বোঝায় তার অর্থ: অক্সফোর্ডডিকোরিয়ালস / ইউএস / ডিফিনিশন / আমেরিকান_ইংলিশ / সিসি (সংজ্ঞা ১.৪)

— স্ট্যাকেক্সচেঞ্জার

119

হ্যাঁ, এটি বেশ অস্পষ্ট।

আপনার পদ্ধতির ডকুমেন্টেশনের পাঠকদের জন্য যখনই এটি ব্যবহার করা উচিত তখন অন্য কোনও পদ্ধতির দিকে নজর দেওয়াও কার্যকর হতে পারে। যদি আপনার মেথডএএর ডকুমেন্টেশনগুলিতে "মেথডিবির মতো কাজ করে তবে ..." বলা হয়, তবে অবশ্যই আপনার একটি লিঙ্ক দেওয়া উচিত। একটি বিকল্প @seeহ'ল ইনলাইন {@link ...}ট্যাগ:

/**
 * ...
 * Works like {@link #methodB}, but ...
 */

যখন মেথডিয়া কলটি মেথডিকে কল করে এটি বাস্তবায়নের বিশদ এবং বাইরে থেকে কোনও সত্যিকারের সম্পর্ক নেই, আপনার এখানে কোনও লিঙ্কের দরকার নেই।

— পাওলো ইবারম্যান
সূত্র

13

@see@Deprecatedপদ্ধতির বিকল্পের সাথে সংযোগ স্থাপনের জন্যও দরকারী ।

— মাউভে রেঞ্জার

1

@ মাউভেরেঞ্জার যেহেতু @seeবেশ অস্পষ্ট, অবহেলিত স্টাফের জন্য আমি আরও স্পষ্ট করে কিছু করা আরও বেশি দরকারী বলে মনে করি:@deprecated since X.Y.Z; use {@link #alternateMethod()} instead

— ক্রিস্টোফার

10

@see একটি এপিআই সম্পর্কিত সম্পর্কিত পদ্ধতি / ক্লাস সম্পর্কে তথ্যের জন্য দরকারী। এটি ডকুমেন্টেশনে রেফারেন্স পদ্ধতি / কোডের একটি লিঙ্ক তৈরি করবে। সম্পর্কিত কোড থাকলে এটি ব্যবহার করুন যা ব্যবহারকারীকে কীভাবে এপিআই ব্যবহার করবেন তা বুঝতে সহায়তা করতে পারে।

— রব ডসন
সূত্র

9

কোনও পরিস্থিতিতে যখন কার্যকর @seeহতে পারে তার একটি উত্তম উদাহরণ হ'ল ইন্টারফেস / বিমূর্ত শ্রেণির পদ্ধতি প্রয়োগ বা প্রয়োগ করা r ঘোষণায় javadocপদ্ধতির বিশদ থাকবে এবং ওভাররাইড / প্রয়োগকৃত পদ্ধতিটি @seeবেসটি উল্লেখ করে একটি ট্যাগ ব্যবহার করতে পারে ।

সম্পর্কিত প্রশ্ন: @see এর সাথে সঠিক জাভাদোক রচনা?

জাভা এসই ডকুমেন্টেশন: @see

— AtomHeartFather
সূত্র

2

আমি ছিলাম না, তবে সম্ভবত এটি ছিল আমাদের @inheritDoc docs.oracle.com/javase/6/docs/technotes/tools/solaris/…

1

@ সি এর জাভা ডকুমেন্টেশন সত্যিই খুব ভাল। প্রথম হওয়া উচিত।

— ডক

2

@ ভ্যাক্সকুইস @inheritDocঅন্য কোনও জায়গা থেকে নথিটি অনুলিপি করে। আমি কল্পনা করি যে ফ্লাফ যুক্ত করার চেয়ে বিশদ বর্ণনা করার সাথে এর ব্যবহার রয়েছে?

— নীলসভ

@ নীলসভগ এই উত্তরে উল্লেখ করেছে যে the overridden/implemented method could use a @see tag, referring to the base one.- এবং ঠিক এটাই @inheritDocযা হয়; আইএমও এর মাধ্যমে উল্লেখ করার চেয়ে বেস ক্লাসের বর্ণনাটি ভারব্যাটিয়ামের মাধ্যমে অন্তর্ভুক্ত করা @inheritDoc এবং এটি প্রয়োজনীয় হিসাবে পরিপূরক করা @seeআরও ভাল - দেখুন (sic!) স্ট্যাকওভারফ্লো / প্রশ্নগুলি / 11121600/… ; অনেক বিকাশকারী (আমার অন্তর্ভুক্ত) একটি উত্তরাধিকারের স্তরক্রমের মাধ্যমে উপরের দিকে লিংকগুলির উপরের দিকে লিভারের চেন্নাইয়ের পরিবর্তে সমস্ত প্রয়োগের বিশদ এক জায়গায় রাখাকে পছন্দ করে।

2

আমি ইন্টারফেস বাস্তবায়ন ক্লাসের পদ্ধতিগুলি বর্ণনা করতে যেখানে @ ইন্টারফেসের জাভাদোকটিতে ইতিমধ্যে পদ্ধতির বর্ণনা সরবরাহ করা হয়েছে তা ব্যবহার করতে আমি @see ব্যবহার করি। যখন আমরা এটি করি যে আমি লক্ষ্য করব যে কোডটি সম্পূর্ণ করার সময় আমি প্রয়োগের রেফারেন্সটির জন্য পদ্ধতিটি দেখছি তখনও Eclipse ইন্টারফেসের ডকুমেন্টেশনগুলিকে টান দেয়

— Maruthi
সূত্র