জাভাডোকের কোনও পদ্ধতি প্যারামিটারের রেফারেন্স কীভাবে যুক্ত করবেন?


313

পদ্ধতি ডকুমেন্টেশন বডি থেকে কোনও পদ্ধতির এক বা একাধিক পরামিতিগুলিতে রেফারেন্স যুক্ত করার কোনও উপায় আছে কি? কিছুটা এইরকম:

/**
 * When {@paramref a} is null, we rely on b for the discombobulation.
 *
 * @param a this is one of the parameters
 * @param b another param
 */
void foo(String a, int b)
{...}

উত্তর:


367

জাভাদোকের জন্য ডকগুলি পড়ার পরে আমি যতদূর বলতে পারি এমন কোনও বৈশিষ্ট্য নেই।

<code>foo</code>অন্যান্য উত্তরে প্রস্তাবিত হিসাবে ব্যবহার করবেন না ; আপনি ব্যবহার করতে পারেন {@code foo}। আপনি যখন জেনেরিক ধরণের যেমন উল্লেখ করেন তখন এটি বিশেষত জেনে রাখা ভাল {@code Iterator<String>}- নিশ্চিতরূপে দেখতে আরও সুন্দর লাগছে <code>Iterator&lt;String&gt;</code>, তাই না!



59

আপনি জাভা.আলং স্ট্রিং ক্লাসের জাভা উত্সে দেখতে পারেন:

/**
 * Allocates a new <code>String</code> that contains characters from
 * a subarray of the character array argument. The <code>offset</code>
 * argument is the index of the first character of the subarray and
 * the <code>count</code> argument specifies the length of the
 * subarray. The contents of the subarray are copied; subsequent
 * modification of the character array does not affect the newly
 * created string.
 *
 * @param      value    array that is the source of characters.
 * @param      offset   the initial offset.
 * @param      count    the length.
 * @exception  IndexOutOfBoundsException  if the <code>offset</code>
 *               and <code>count</code> arguments index characters outside
 *               the bounds of the <code>value</code> array.
 */
public String(char value[], int offset, int count) {
    if (offset < 0) {
        throw new StringIndexOutOfBoundsException(offset);
    }
    if (count < 0) {
        throw new StringIndexOutOfBoundsException(count);
    }
    // Note: offset or count might be near -1>>>1.
    if (offset > value.length - count) {
        throw new StringIndexOutOfBoundsException(offset + count);
    }

    this.value = new char[count];
    this.count = count;
    System.arraycopy(value, offset, this.value, 0, count);
}

প্যারামিটারের রেফারেন্সগুলি চারপাশে <code></code>ট্যাগগুলি দ্বারা আবৃত, যার অর্থ জাভাদোক সিনট্যাক্স এ জাতীয় কোনও কাজ করার কোনও উপায় সরবরাহ করে না। (আমি মনে করি স্ট্রিং.ক্লাস জাভাদোক ব্যবহারের একটি ভাল উদাহরণ)।


5
<code> </code> ট্যাগ কোনও নির্দিষ্ট পরামিতিটি উল্লেখ করে না। এটি "কোডিং" পাঠ্যে "স্ট্রিং" শব্দটি ফর্ম্যাট করছে।
নেক্সোস 84

46

কোনও পদ্ধতি প্যারামিটারের উল্লেখ করার সঠিক উপায়টি এরকম:

এখানে চিত্র বর্ণনা লিখুন


2
এটি বিদ্যমান উত্তরের সাথে কিছু যোগ করে না। এটা দয়া করে মুছে দিন.
সুরভ

27
এটি কেবল প্রশ্নের উত্তর দেয় না, তবে ইন্টেলিজের মতো আইডিই ব্যবহার করে জাভাদোককে কীভাবে প্যারামিটার দিয়ে সংশোধন করা যায় তা দৃশ্যত ব্যাখ্যা করে। উত্তর অনুসন্ধানের জন্য অনুসন্ধানকারীদের জন্য এটি কার্যকর হবে।
ইউরিগ জোনস

1
অ্যালিপসে এটি কাজ করে না। তবে তা সত্ত্বেও এটি একটি দুর্দান্ত উত্তর
হেনরিক ডি সুসা

2
এটি মুছে ফেলা উচিত। কল্পনা আর নেই।
ব্যবহারকারী4504267

2
@ user4504267 চিত্র কমপক্ষে এখন ঠিক আছে।
এরিক

11

আমার ধারণা আপনি এই আচরণটি সমর্থন করার জন্য আপনার নিজের ডকলেট বা ট্যাগলেট লিখতে পারেন।

ট্যাগলেট ওভারভিউ

ডোকলেট ওভারভিউ


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