javadocs

Question

में छवियों सहित मैं दृश्य के बहुत से नमूना परीक्षण मामलों के साथ काम करता हूं। क्या उनके जावा स्रोत में उन्हें शामिल करने और उन्हें जावाडॉक्स में जोड़ने का कोई सुविधाजनक तरीका है, इसलिए मेरा आईडीई स्वचालित रूप से कोडिंग करते समय उन्हें दिखा सकता है (मेरे आईडीई में एक जावाडॉक रेंडरर सुविधा का आह्वान करके?)

मैंने एक छवि को आगे रखने की कोशिश की जावा स्रोत और <img> का उपयोग कर, लेकिन यह नहीं ले रहा है (मैंने एक पीएनजी का उपयोग किया)।

(नोट - यह इस मामले में अपने परीक्षण स्रोतों में है)

Answer 1

आप किसी भी स्रोत नहीं दिखाया के रूप में, मैं केवल एक गिलास गेंद अनुमान कर सकते हैं ...

किसी भी फाइल कर रहे हैं जो के लिए दस्तावेज़ीकरण उद्देश्यों के लिए आवश्यक है, किसी को उन्हें अपनी पैकेज निर्देशिकाओं के doc-files नामक एक उपनिर्देशिका में रखना चाहिए। इसके बाद उन्हें जवाडोक द्वारा आउटपुट निर्देशिका में कॉपी किया जाएगा। फिर <img> तत्व में एक सापेक्ष पथ का उपयोग करें।

मुझे यकीन नहीं है कि आपका आईडीई का जावाडोक रेंडरर ऐसा ही करेगा, लेकिन यह एक कोशिश के लायक है।

Answer 2

थोड़ा दूर लाया गया, लेकिन आप दस्तावेजों में उन्हें बेस 64 में परिवर्तित करके दस्तावेजों को रेखांकित कर सकते हैं। यह इस तरह दिखेगा:

<img src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADIA..." /> 

वहाँ ऑनलाइन उपकरण रूपांतरण करने के लिए उपलब्ध हैं:

• http://www.base64-image.de
• http://daturi.me
• http://www.freeformatter.com/base64-encoder.html

Answer 3

ग्रहण लूना निम्नलिखित काम करता है के साथ

मेरे लिए।

• कॉम
  • कंपनी
    • somepackage
      • डॉक-फ़ाइलें
        • image.png
      • Test.java

Test.java के जावाडोक में अब

:

/** 
* <img src="./doc-files/image.png" /> 
*/ 

और ग्रहण छवि दिखाता दोनों पॉपअप मदद में, जब आप माउस होवर करें, और जावाडोक व्यू में।

आप style="width: 100%;" को img टैग में भी जोड़ सकते हैं, इसलिए छवि दृश्य/पॉपअप आकार में समायोजित होती है।

Answer 4

पालो के जवाब पर थोड़ा विस्तार करने के लिए यहां एक मेवेन निर्माण का मानना ​​है कि जेडीके -8 (कठोर HTML सत्यापन) के साथ मेरे लिए क्या काम किया गया है, इस शर्त के साथ कि आप जावाडोक उपकरण चलाने के इच्छुक हैं।

दुर्भाग्यवश नेटबींस के साथ मैं आईडीई के जावाडोक पॉपअप में छवि नहीं देख सकता, मैंने अभी this netbeans bug खोला है।

मान लें इस com.foo.File.java के लिए जावाडोक का हिस्सा है (नोटिस नहीं img समाप्ति टैग, जो w3schools प्रति सही तरीका है):

<img src="doc-files/foo.png" alt="Foo"> 

Maven निर्देशिका संरचना आप हूँ में यहाँ छवि मिल: pom.xml में src/main/javadoc/com/foo/doc-files/foo.png

और आखिरी, (नोटिस docfilessubdirs सही पर सेट है):

<build> 
    <plugins> 
     <plugin> 
      <groupId>org.apache.maven.plugins</groupId> 
      <artifactId>maven-javadoc-plugin</artifactId> 
      <version>2.10.3</version> 
      <configuration> 
       <docfilessubdirs>true</docfilessubdirs> 
      </configuration> 
     </plugin> 
     ... 

Answer 5

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

 /** 
    * <img src="../../../../../../resources/com/my/project/client/images/myImage.png"><br> 
    * Icon for myImage. 
    * 
    * @return the icon 
    */ 

यह मैं पहले से अधिक छवियों का प्रबंधन करने के लिए बस फ़ोल्डर वास्तविक चित्र में झूठ पर जाकर की जरूरत नहीं है की तरह