2009-09-21 10 views
11

क्या जावावाक को सामान्य जावाडॉक के HTMLish सिंटैक्स के बजाय विकी-शैली सिंटैक्स की तुलना में एक उपकरण है?क्या कोई जवाडोक प्रतिस्थापन है जो विकी-जैसी वाक्यविन्यास का उपयोग करता है?

मेरी समस्याओं में से एक यह है कि मैं ज्यादातर स्रोत रूप में जावाडोक पढ़ता हूं। बाहरी पुस्तकालयों के लिए भी मैं स्रोत संलग्न करने का प्रयास करता हूं ताकि मैं इसे अपने आईडीई से नेविगेट कर सकूं, प्रविष्टि बिंदु के ऊपर दस्तावेज़ों की जांच कर रहा हूं और यदि आवश्यक हो तो कोड नीचे।

दूसरी समस्या यह है कि सूचियों और कोड नमूने जैसी चीजें लिखने के लिए गन्दा हैं, खासकर यदि आपका आईडीई प्रत्येक पंक्ति पर सितारों को लगाने पर जोर देती है। क्या मैं देखना चाहेंगे कुछ कम से कम निम्न सुविधाओं के साथ विकी वाक्य रचना का एक प्रकार का उपयोग करता है:

  • सूचियों
  • कोड ब्लॉक
  • तरीकों के crosslinking/वर्गों

रहे हैं कई और चीजें जो अच्छी होंगी, लेकिन मेरा मानना ​​है कि ये आवश्यक हैं।

क्या कोई इस तरह के उपकरण के बारे में जानता है?

+0

कोड ब्लॉक '{@code}' के साथ बहुत खराब नहीं हैं। मुझे लगता है कि '{@link} 'सदस्यों और प्रकारों से लिंक करने के लिए उचित रूप से अच्छी तरह से काम करता है। –

+0

जब आप विकी-स्टाइल डिस्प्ले के बारे में सोच रहे हों, तो आप बहुत अच्छा होगा अगर आप इसे विकी-स्टाइल भी संपादित कर सकते हैं, और इसे टिप्पणियों में वापस ला सकते हैं। मुझे संदेह है कि थोड़ा सा पूछ रहा है। – Carl

उत्तर

3

WikiDoclet नामक एक प्रोजेक्ट है, मैंने इसका कभी भी उपयोग नहीं किया है, लेकिन मुझे यह देखने में दिलचस्पी होगी कि आप इसके बारे में क्या सोचते हैं।

साइट से:

यह जावा JDK के साथ प्रदान की मानक जावाडोक doclet लिए एक विस्तार है। यह विकी स्वरूपण को कॉल करने के लिए समर्थन जोड़ता है। इसका अर्थ यह है कि जावाकाक में एम्बेडेड एचटीएमएल की तुलना में आंखों पर आसान टेक्स्ट नियमों का उपयोग करके आपके जावाडॉक को स्वरूपित किया जा सकता है। उदाहरण के लिए, सितारों के साथ पाठ के एक टुकड़े पर जोर देने के लिए। अंडरस्कोर अंडरस्कोर। जब जावाडॉक बनाने के लिए डॉकलेट चलाया जाता है तो इन नियमों का मूल्यांकन किया जाता है और एचटीएमएल प्रतिस्थापन किए जाते हैं। इस प्रारूपण को जावा स्रोत कोड को बहुत आसान बनाना चाहिए क्योंकि यह अब HTML टैग्स के साथ अव्यवस्थित नहीं होगा। यह बुलेट सूचियों और तालिकाओं के लिए विशेष रूप से सच है। एचटीएमएल अभी भी संरक्षित है, इसलिए आप अपनी पसंद के अनुसार मिश्रण और मिलान कर सकते हैं।

अन्य डॉकलेट प्रारूपों के लिए, doclet.com देखें।

+0

अच्छा लिंक - धन्यवाद। मैं इसे एक शॉट दूंगा। –