2013-08-22 11 views
5

मुझे इस प्रश्न का उत्तर नहीं मिला है- यह प्रोग्रामिंग प्रश्न से अधिक दस्तावेज़ीकरण के लिए एक अंग्रेजी भाषा प्रश्न है।प्रलेखन में बहुवचन उदाहरणों का जिक्र करने के लिए सम्मेलन

class Foo { 
    public void checkBar(Collection<Bar> bars) { 
     ... 
    } 
} 

checkBar (...) के लिए मेरे प्रलेखन में, वहाँ ध्यान देने योग्य बात के लिए एक आम सम्मेलन है कि कई बार उदाहरणों, जैसे के साथ विधि से संबंधित है।

/** 
* checkBar(...) checks a set of (Bar instances) or (Bar/s) or 
* (Bar objects) or (a Bar set) 
*/ 
+0

यह प्रोग्रामर के एसओ के लिए बेहतर होगा। –

उत्तर

4

मैं के साथ जाना होगा "का एक संग्रह की जाँच करता है {@link बार} s" उन बार जावाडोक के लिए कूद करने बार पर क्लिक कर सकते हैं ताकि जो JavaDoc के लिंक का उपयोग करें।

मैं "बार सेट" से दूर रहूंगा क्योंकि इंटरफ़ेस Collection<Bar>Set<Bar> नहीं है जो भ्रमित हो सकता है।

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