জাভাদোক @see বা {@ লিঙ্ক}?


184

কেউ আমাকে জাভাডোক @seeএবং এর মধ্যে পার্থক্য বলতে পারে {@link}?

বা বরং, তাদের কোনটি ব্যবহার করবেন?

উত্তর:


213

এটি সম্পর্কে সরকারী নির্দেশিকা বেশ পরিষ্কার।

কার্যকরী পার্থক্যগুলি হ'ল:

  • {@link} একটি ইনলাইন লিঙ্ক এবং যেখানে খুশি সেখানে স্থাপন করা যেতে পারে
  • @see নিজস্ব বিভাগ তৈরি করে

আমার মতে, {@link}আপনি যখন বর্ণনায় কোনও শ্রেণি, ক্ষেত্র, নির্মাতা বা পদ্ধতির নামটি আক্ষরিকভাবে ব্যবহার করেন তখন সেরা ব্যবহার করা হয়। ব্যবহারকারী আপনি যা লিঙ্ক করেছেন তার জাভাদোকটিতে ক্লিক করতে সক্ষম হবেন।

আমি @see2 টি ক্ষেত্রে টীকাটি ব্যবহার করি :

  • কিছু খুব প্রাসঙ্গিক তবে বর্ণনায় উল্লেখ নেই।
  • আমি বর্ণনায় একই জিনিসটি একাধিকবার উল্লেখ করি এবং এটি একই সাথে একাধিক লিঙ্কের প্রতিস্থাপন হিসাবে ব্যবহৃত হয়।

আমি স্ট্যান্ডার্ড লাইব্রেরিতে বিভিন্ন ধরণের জিনিসের জন্য এলোমেলোভাবে ডকুমেন্টেশন যাচাই করে এই মতামতটি ভিত্তি করেছিলাম


3
জাভাডোক সতর্ক করে দেয় যে @ লিঙ্কটি বরং নিবিড় এবং প্রয়োজনে কেবল ব্যবহার করা উচিত।
থমাস

4
যে কারও সন্ধানের জন্য,@link আপনি ওরাকলের জাভাদোক গাইডটিতে ( উপরের মন্তব্যে সতর্কতা সহ) বিশদটি পেতে পারেন ।
অ্যাশ রায়ান আরনওয়াইন

48

@seeজাভাডোক্সে একটি বিচ্ছিন্ন রেখা তৈরি করে। {@link}পাঠ্যের মধ্যে এম্বেড করার জন্য।

আমি @seeযখন এটি সম্পর্কিত কোনও সত্তা ব্যবহার করি তবে আমি এটি এক্সপোজিটরি পাঠ্যে উল্লেখ করি না। টাইট কাপলিং থাকাকালীন আমি টেক্সটের মধ্যে লিঙ্কগুলি ব্যবহার করি বা (আমার মনে হয়) সম্ভবত নেভিগেশন ইঙ্গিতটি পাঠক উপকৃত হতে পারে, যেমন, আপনাকে এটি সরাসরি উল্লেখ করতে হবে।


3

অন্য রেফারেন্স (থামিয়ে দেওয়া অধ্যায়) একই কর্মকর্তা ডক্স পছন্দ {@link}উপর @see(জাভা 1.2 থেকে):

জাভাডোক ১.২ এবং তার পরে, স্ট্যান্ডার্ড ফর্ম্যাটটি হ'ল ডেপ্রেসিটেড ট্যাগ এবং ইন-লাইন {@ লিঙ্ক} ট্যাগটি ব্যবহার করা। এটি লিংকটিকে লাইন তৈরি করে, যেখানে আপনি এটি চান। উদাহরণ স্বরূপ:

জাভাডোক ১.১-এর জন্য, স্ট্যান্ডার্ড ফর্ম্যাটটি হ'ল একটি জুড়ি তৈরি করা হবে যা "ডেপ্রেসিটেড এবং @ এসি ট্যাগ" রয়েছে। উদাহরণ স্বরূপ:

আমাদের সাইট ব্যবহার করে, আপনি স্বীকার করেছেন যে আপনি আমাদের কুকি নীতি এবং গোপনীয়তা নীতিটি পড়েছেন এবং বুঝতে পেরেছেন ।
Licensed under cc by-sa 3.0 with attribution required.