जावदोक का अच्छा उदाहरण [बंद]


140

वहाँ एक स्रोत फ़ाइल Javadoc युक्त का एक अच्छा उदाहरण है ?

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

जवाबों:


118

JDK स्रोत कोड के बारे में कैसे, लेकिन एक 3 पार्टी के माध्यम से पहुँचा जैसे docjar? उदाहरण के लिए, संग्रह स्रोत

इस तरह, कोई बड़ा डाउनलोड नहीं है।


1
जोश और नील द्वारा लिखे गए संग्रह के बाद से यह एक अच्छा जवाब है।
चेरोविम

मेरा एंटीवायरस सॉफ्टवेयर कहता है कि डोजर लिंक असुरक्षित है। क्या आप किसी अन्य वेबसाइट के बारे में जानते हैं जो संग्रह स्रोत को सुविधा प्रदान करती है? (अगर यह एक बहुत ही उच्च यातायात सवाल नहीं था तो मैं इसे स्लाइड करने
दूंगा

2
यदि विंडोज़ पर, JDK इंस्टॉलेशन में src.zipस्टैंडर्ड लाइब्रेरीज़ के सोर्स कोड वाली फाइल होती है।
श्री हर्ष चिलकापति

किसी 3 पार्टी के लिए कॉपीराइट कोड वितरित करना कैसे कानूनी है? या कॉपीराइट इसकी अनुमति देता है?
thePyroEagle

बाहरी लिंक के साथ यह मुख्य समस्या है, "Docjar.net सभी के लिए DOWN है।"
ज़ीउस

39

Javadoc टूल के लिए पेज हाउ टू राइट डॉक कॉमेंट्स में अच्छी संख्या में अच्छे उदाहरण हैं। एक सेक्शन को डॉक कमेंट्स का उदाहरण कहा जाता है और इसमें बहुत सारे उपयोग शामिल हैं।

इसके अलावा, Javadoc FAQ में उत्तरों को चित्रित करने के लिए कुछ और उदाहरण हैं।


फिक्स्ड लिंक (अभी के लिए): oracle.com/technetwork/java/javase/documentation/…
जेफ इवान्स

9

JDK स्रोत कोड के बारे में कैसे ?


यह मेरा स्पष्ट विचार था लेकिन मुझे पूरी बड़ी गड़बड़ डाउनलोड करनी होगी। :-(
जेसन एस

5
संभावना है कि आपके पास पहले से ही यह है, क्योंकि यह जेडीके के साथ आता है (हालांकि यह एक स्थापना विकल्प है)।
माइकल बोर्गवर्ड

5

मैं प्रलेखन पैटर्न का एक छोटा सा सेट उपयोग करता हूं:

  • हमेशा थ्रेड-सुरक्षा के बारे में दस्तावेज
  • हमेशा अपरिवर्तनीयता का दस्तावेजीकरण
  • उदाहरणों के साथ javadoc ( फ़ॉर्मेट की तरह )
  • डुप्लिकेट तत्व को बदलने के लिए WHY और HOW के साथ @Deprecation

महान संकेत
इंगित

4

स्प्रिंग फ्रेमवर्क स्रोत पर एक नज़र डालें, इसमें उत्कृष्ट javadocs हैं



2

ल्यूसिने के स्रोतों को डाउनलोड करें और देखें कि वे इसे कैसे करते हैं। उनके पास अच्छे JavaDocs हैं।


2

यदि आप ग्रहण का उपयोग कर रहे हैं , तो आप स्थापित JRE में अपना JDK ( JRE नहीं ) सेटअप कर सकते हैं , और फिर ओपन टाइप ( + + ) का उपयोग कर सकते हैं, कुछ ऐसा दे सकते हैंCtrlShiftTjava.util.Collections


1
जो कहा गया था उसे जोड़ने के लिए, अधिकांश आईडीई स्वचालित रूप से javadocs और स्रोत को कॉन्फ़िगर करते हैं जब आप JDK को उनके उपयोग के लिए कॉन्फ़िगर करते हैं। यह केवल ग्रहण पर लागू नहीं होता है।
thePyroEagle


1

यदि आप एक JDK स्थापित करते हैं और स्रोत भी स्थापित करना चुनते हैं, तो src.zip में सभी सार्वजनिक जावा कक्षाओं के स्रोत शामिल हैं। इनमें से अधिकांश में बहुत अच्छा javadoc है।


1

यदि आपकी सभी खोज वाक्य रचना है, तो इससे मदद मिल सकती है:

Javadoc टूल के लिए डॉक टिप्पणियां कैसे लिखें


1
धन्यवाद, पहले से ही पता है कि हालांकि (मेरा सवाल देखें)
जेसन एस

अन्य उपयोगी जानकारी प्रदान किए बिना डुप्लिकेट उत्तर।
एलेक्सी इवानोव
हमारी साइट का प्रयोग करके, आप स्वीकार करते हैं कि आपने हमारी Cookie Policy और निजता नीति को पढ़ और समझा लिया है।
Licensed under cc by-sa 3.0 with attribution required.