मैं एक छोटी सी लाइब्रेरी पर काम कर रहा हूँ जो बुनियादी, प्रसिद्ध स्ट्रिंग मेट्रिक्स का कार्यान्वयन प्रदान करती है। ज्यादातर मेरी अपनी शिक्षा के लिए। जब भी थोड़ा खाली समय मिलता है तो विकास होता है।
इस वजह से मैंने अधिकांश प्रक्रियाओं को स्वचालित कर दिया है, इसलिए मैं एक संस्करण जारी कर सकता हूं जितनी बार मैं इस पर काम करता हूं, बहुत अधिक प्रयास के बिना। हालाँकि जावा डॉक को बनाए रखना अभी भी एक बोझ है क्योंकि इसमें उदाहरण शामिल हैं।
जैसा कि एपीआई विकसित होता है, मुझे मैन्युअल रूप से प्रत्येक उदाहरण को बार-बार जांचना होगा। क्या ऐसा करने के लिए इससे अच्छा तरीका है?
मैंने प्रलेखन और उदाहरणों को एक अलग परियोजना (जैसे कैलिपर ट्यूटोरियल ) में स्थानांतरित करने पर विचार किया है ताकि इसे नियमित रूप से कोड के साथ-साथ फिर से संकलित और संकलित किया जा सके। हालाँकि यह दस्तावेज़ीकरण को उस वर्ग से दूर ले जाता है जिसके बारे में यह है।
तो हाँ। मैं अपना केक लेना चाहता हूं और इसे भी खाना चाहता हूं। : डी
* <h2>Tokenization</h2>
*
* Tokenization cuts up a string into tokens e.g.
* <code>chilperic ii son of childeric ii</code> is tokenized into
* <code>[chilperic, ii, son, of,
* childeric, ii]</code>. Tokenization can also be done repeatedly by tokenizing
* the individual tokens e.g.
* <code>[ch,hi,il,il,lp,pe,er,ri,ic, ii, so,on, of, ch,hi,il,ld,de,er,ri,ic, ii]</code>
* <p>
*
* <pre>
* <code>
* {@code
* return new StringMetricBuilder()
* .with(new SimonWhite<String>())
* .tokenize(new Whitespace())
* .tokenize(new QGram(2))
* .build();
* }
* </code>
* </pre>
*
* <p>यदि ऊपर यह बहुत सार है। यह प्रलेखन का एक नमूना है। वर्तमान में मैं Tokenizers.createQGram(2)कंस्ट्रक्टर विधि की सराहना करते हुए प्रभावी जावा जैसे की सलाह देते हुए स्थिर कंस्ट्रक्टर जोड़ रहा हूं । हर बार जब मैं ऐसा कुछ करता हूं, मुझे ऊपर दिए गए उदाहरण कोड को अपडेट करना होगा और जांचना होगा कि क्या यह अभी भी काम करता है।