2015-05-14 11 views
11

मैं सामान्य प्रकार के साथ विधि निम्नलिखित है उम्मीद @param टैग, लेकिन यह रखा जब मैं Maven checkstyle (Maven-checkstyle-प्लग इन, 2.121) चलाने मुझे Maven निर्माण के दौरान Expected @param tag for '<T>' त्रुटि संदेश देता है। मैं इसके साथ कैसे हो सकता हूं?Maven checkstyle त्रुटि: '<T>'

/** 
* Read in specified type of object from request body. 
* @param request The HttpServletRequest 
* @param expected The expected type T 
* @return <T> specified type of object 
*/ 
public <T extends Object> T getExpectedValue(
    final HttpServletRequest request, final Class<T> expected) 

मैं सामान्य परम टैग बंद करने के लिए निम्नलिखित का इस्तेमाल किया है, लेकिन यह काम नहीं किया है और मैं इसके बाद के संस्करण जावा दस्तावेज़ के रूप में अच्छी तरह से उल्लेख किया है।

<module name="JavadocType"> 
    <property name="allowMissingParamTags" value="true"/> 
</module> 
+1

तुम्हें पता है:

/** * ... * @param <T> This is the type parameter * @param .... */ public <T extends Object> T getExpectedValue( final HttpServletRequest request, final Class<T> expected) 

उत्पादित जावाडोक शीर्षक में निम्नलिखित की तरह एक खंड शामिल होंगे यह एक जावाडोक चेतावनी है, है ना? यह कह रहा है कि आपके पास टी – immibis

+0

के लिए जावाडोक नहीं है यदि आप allowMissingParamTags को बंद करना चाहते हैं तो आपको JavadocType के बजाय JavadocMethod मॉड्यूल का उपयोग करने की आवश्यकता है। दस्तावेज़: http://checkstyle.sourceforge.net/config_javadoc.html – zappee

उत्तर

11

यह कह रहा है कि आप विधि प्रकार पैरामीटर के लिए जावाडोक नहीं लिखा था:

Type Parameters: 
    T - This is the type parameter 
+1

लेकिन आपके पास मेरे उत्तर में जोड़ने के लिए लाइन नहीं है –

+0

क्या मुझे अपने जावा दस्तावेज़ को अतिरिक्त रूप से जोड़ने या मेरे पास एक लाइन को प्रतिस्थापित करने की आवश्यकता है? क्या आप मुझे बता सकते हैं कि कौन सी रेखा गलत है? – user2482822

+1

आपके पास गलत लाइन नहीं है, यह इसके अतिरिक्त है; यह विधि प्रकार पैरामीटर का प्रलेखन है, जो तर्कों के दस्तावेज़ को पूरा करता है और वापसी (जो आपके पास पहले से है) –

3

आप अपने जावाडोक में टी के लिए @param टैग जोड़ते हैं।

कुछ इस तरह:

/** 
* ... other comments here ... 
* @param T The expected class of the value. 
* @param request ... other comments here ... 
* @param expected ... other comments here ... 
* @return ... other comments here ... 
*/ 
public <T extends Object> T getExpectedValue(
    final HttpServletRequest request, final Class<T> expected) 

आप नहीं हैं जावाडोक का उपयोग कर, तो आप शायद जावाडोक चेतावनी सक्षम नहीं होना चाहिए।

+0

क्या आप मेरे जावा दस्तावेज़ को देख सकते हैं? – user2482822

संबंधित मुद्दे