2013-08-16 9 views
8

जावाडोक सारांश वाक्य के रूप में दस्तावेज़ टिप्पणी के पहले "वाक्य" का उपयोग करता है। यह मानता है कि एक स्पेस, टैब, या लाइन टर्मिनेटर के बाद की अवधि वाक्य समाप्त होती है। मान लीजिए कि मैं "उदा।" जैसे संक्षिप्त नाम चाहता हूं या "आदि" मेरे सारांश में; क्या जवाडोक को यह बताने का कोई तरीका है कि इसे वाक्य के अंत के रूप में न मानें? मैं . के साथ अवधि को प्रतिस्थापित कर सकता हूं लेकिन मुझे आश्चर्य है कि अगर कोई बदसूरत तरीका है।जावाडोक को बताएं कि मेरी अवधि वाक्य को समाप्त नहीं करती है

उत्तर

4

पहली वाक्य में अवधि से बचने के लिए सबसे अच्छा है। How to Write Doc Comments for the Javadoc Tool में यह सुझाव दिया जाता है कि आप एक समाधान के रूप अंतरिक्ष चरित्र बदलना चाहिए:

/** 
* This is a simulation of Prof. Knuth's MIX computer. 
*/ 

/** 
    * This is a simulation of Prof.<!-- --> Knuth's MIX computer. 
    */ 

व्यक्तिगत रूप से, मैं सिर्फ डॉट को छोड़ अगर मैं संक्षिप्त रूपों को पूरी तरह से बचने नहीं कर सकता है।

+0

धन्यवाद, यह हैक के मुकाबले यह निश्चित रूप से बेहतर है। मैं वर्तनी चीजों के बारे में बहुत खास हूं korrecktlee तो डॉट को छोड़कर वास्तव में मेरे लिए एक विकल्प नहीं है। – ajb

+0

@ajb मैंने इसका परीक्षण नहीं किया है, लेकिन हो सकता है कि आप HTML इकाई का उपयोग किए बिना सीधे [गैर-ब्रेकिंग स्पेस इनपुट करें] (https://en.wikipedia.org/wiki/Non-breaking_space#Keyboard_entry_methods) भी कर सकते हैं। – Kapep

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