Javadoc में विधि पैरामीटर के संदर्भ को कैसे जोड़ा जाए?

Question

क्या विधि प्रलेखन निकाय से किसी विधि के एक या अधिक मापदंडों के संदर्भ जोड़ने का कोई तरीका है? कुछ इस तरह:

/**
 * 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)
{...}

Answer 1

जहां तक ​​मैं javadoc के लिए डॉक्स पढ़ने के बाद बता सकता हूं, ऐसी कोई सुविधा नहीं है।

<code>foo</code>अन्य उत्तरों में अनुशंसित अनुसार उपयोग न करें ; आप उपयोग कर सकते हैं {@code foo}। जब आप एक सामान्य प्रकार का उल्लेख करते हैं तो यह जानना विशेष रूप से अच्छा है {@code Iterator<String>}- निश्चित रूप से अच्छा लगता है <code>Iterator&lt;String&gt;</code>, है ना!

Comments

@codeटैग में वर्णन किया गया है टैग वर्णन - जावाडोक । JDK8 कोड में नमूना उपयोग देखें ।

— पीपीए

Answer 2

जैसा कि आप java.lang.String वर्ग के जावा स्रोत में देख सकते हैं:

/**
 * 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>टैग से घिरे होते हैं , जिसका अर्थ है कि Javadoc सिंटैक्स ऐसा काम करने का कोई तरीका प्रदान नहीं करता है। (मुझे लगता है कि String.class javadoc उपयोग का एक अच्छा उदाहरण है)।

Comments

<Code> </ code> टैग किसी विशिष्ट पैरामीटर को संदर्भित नहीं कर रहा है। यह शब्द "स्ट्रिंग" को "कोड लुकिंग" टेक्स्ट में फ़ॉर्मेट कर रहा है।

— नक्सोसॉ

Answer 3

एक विधि पैरामीटर को संदर्भित करने का सही तरीका इस प्रकार है:

Comments

यह मौजूदा उत्तरों में कुछ भी नहीं जोड़ता है। कृपया इसे हटा दें।

— at१३:

न केवल यह सवाल का जवाब देता है, बल्कि यह नेत्रहीन बताता है कि इंटेलीज जैसे आईडीई का उपयोग करके एक पैरामीटर के साथ जावदोक को कैसे संशोधित किया जाए। यह उन खोजकर्ताओं के लिए उपयोगी होगा जो उत्तर की तलाश में हैं।

— यूरिग जोंस

ग्रहण पर यह काम नहीं करता है। लेकिन फिर भी यह एक अच्छा जवाब है

— हेनरिक डी सूसा

इसे हटा दिया जाना चाहिए। कल्पना अब मौजूद नहीं है।

— user4504267

@ user4504267 छवि ठीक दिखती है, कम से कम अब।

— एरिक

Answer 4

मुझे लगता है कि आप इस व्यवहार का समर्थन करने के लिए अपना खुद का डॉकलेट या टैगलेट लिख सकते हैं।

टैगलेट अवलोकन

डॉकलेट अवलोकन

Comments

और जावाडोक को :) एक पुल अनुरोध करना

— Juh_