วิธีสร้างความคิดเห็น javadoc ใน Android Studio

ฉันสามารถใช้ปุ่มทางลัดในสตูดิโอ Android เพื่อสร้างความคิดเห็น javadoc ได้หรือไม่?

ถ้าไม่เป็นวิธีที่ง่ายที่สุดในการสร้างความคิดเห็น javadoc คืออะไร?

ฉันไม่พบทางลัดใด ๆ ในการสร้างความคิดเห็น javadoc แต่ถ้าคุณพิมพ์/**ก่อนการประกาศเมธอดและกด Enter บล็อกข้อคิดเห็น javadoc จะถูกสร้างขึ้นโดยอัตโนมัติ

อ่านสิ่งนี้สำหรับข้อมูลเพิ่มเติม

เพื่อ generatae ประเภทความคิดเห็นที่สำคัญก่อนที่จะประกาศวิธีและกด/** Enterมันจะสร้างความคิดเห็น javadoc

ตัวอย่าง:

/**
* @param a
* @param b
*/

public void add(int a, int b) {
    //code here
}

สำหรับข้อมูลเพิ่มเติมตรวจสอบลิงค์ https://www.jetbrains.com/idea/features/javadoc.html

นี่คือตัวอย่างของความคิดเห็น JavaDoc จาก Oracle :

/**
 * Returns an Image object that can then be painted on the screen. 
 * The url argument must specify an absolute {@link URL}. The name
 * argument is a specifier that is relative to the url argument. 
 * <p>
 * This method always returns immediately, whether or not the 
 * image exists. When this applet attempts to draw the image on
 * the screen, the data will be loaded. The graphics primitives 
 * that draw the image will incrementally paint on the screen. 
 *
 * @param  url  an absolute URL giving the base location of the image
 * @param  name the location of the image, relative to the url argument
 * @return      the image at the specified URL
 * @see         Image
 */
 public Image getImage(URL url, String name) {
        try {
            return getImage(new URL(url, name));
        } catch (MalformedURLException e) {
            return null;
        }
 }

รูปแบบพื้นฐานสามารถสร้างขึ้นโดยอัตโนมัติด้วยวิธีใดวิธีหนึ่งต่อไปนี้:

• วางเคอร์เซอร์ไว้เหนือวิธีและประเภท /** +Enter
• วางเคอร์เซอร์บนชื่อเมธอดและกดAlt+ Enter> คลิกเพิ่ม JavaDoc

คุณสามารถติดตั้ง JavaDoc plugin จาก Settings-> Plugin-> เรียกดูที่เก็บ

รับเอกสารปลั๊กอินจากลิงค์ด้านล่าง

เอกสารปลั๊กอิน JavaDoc

คุณสามารถใช้สไตล์ eclipse ของการสร้างความคิดเห็น JavaDoc ผ่าน "แก้ไขความคิดเห็น doc" เปิด "การตั้งค่า" -> "Keymap" และกำหนดการ "แก้ไขความคิดเห็น doc" ให้กับคีย์ที่คุณต้องการ

ที่นี่เราสามารถบางอย่างเช่นนี้ และแทนที่จะใช้ทางลัดใด ๆ เราสามารถเขียนความคิดเห็น "เริ่มต้น" ในระดับชั้น / แพ็คเกจ / โครงการ และแก้ไขตามความต้องการ

   *** Install JavaDoc Plugin ***



     1.Press shift twice and  Go to Plugins.
     2. search for JavaDocs plugin
     3. Install it. 
     4. Restart Android Studio.
     5. Now, rightclick on Java file/package and goto 
        JavaDocs >> create javadocs for all elements
        It will  generate all default comments.

ข้อดีคือคุณสามารถสร้างบล็อกความคิดเห็นสำหรับ all the methods at a time.

ความคิดเห็น Javadoc สามารถต่อท้ายโดยอัตโนมัติโดยใช้คุณสมบัติการเติมข้อความอัตโนมัติของ IDE ลองพิมพ์/**และกดปุ่มEnterเพื่อสร้างตัวอย่างความคิดเห็น Javadoc

 /**
 *
 * @param action          The action to execute.
 * @param args            The exec() arguments.
 * @param callbackContext The callback context used when calling back into JavaScript.
 * @return
 * @throws JSONException
 */

ใน Android Studio คุณไม่จำเป็นต้องใช้ปลั๊กอินบน Mac เพียงเปิด Android Studio -> คลิก Android Studio ในแถบด้านบน -> คลิก Prefrences -> ค้นหาเทมเพลตไฟล์และรหัสในรายการ -> select include -> build it และจะยังคงอยู่ในโครงการของคุณทั้งหมด

• อีกวิธีในการเพิ่มความคิดเห็น java docs คือกด: Ctrl + Shift + A >> แสดงป๊อปอัป >> ประเภท: เพิ่ม javadocs >> Enter

• Ctrl + Shirt + A: การค้นหาคำสั่ง (ชื่อคำสั่งเติมข้อความอัตโนมัติ)

เพียงเลือก (เช่นคลิก) ชื่อวิธีจากนั้นใช้คีย์ผสม Alt + Enter เลือก "เพิ่ม JavaDoc"

สิ่งนี้ถือว่าคุณยังไม่ได้เพิ่มความคิดเห็นไว้เหนือวิธีการอื่นตัวเลือก "เพิ่ม JavaDoc" จะไม่ปรากฏขึ้น

ในสตูดิโอ Android เรามีวิธีการแสดงความคิดเห็นโดยอัตโนมัติ:

• วิธีที่ 1:

โดยการพิมพ์ / ** แล้วกด Enter คุณสามารถสร้างบรรทัดความคิดเห็นถัดไปและมันจะสร้าง params ฯลฯ โดยอัตโนมัติ แต่เมื่อคุณต้องการปุ่มลัดสำหรับวิธีการเช็คเอาต์นี้ทางด้านล่าง

• ** วิธีที่สอง: **

1 - ไปที่เมนูด้านบน

2 - ไฟล์> การตั้งค่า

3 - เลือก Keymap จากการตั้งค่า

4 - ที่แถบค้นหาด้านบนขวาค้นหา "แก้ไขหมอ"

5 - เลือก "แก้ไขความคิดเห็น doc" จากผลลัพธ์และดับเบิลคลิกที่มัน

6 - เลือกเพิ่มแป้นพิมพ์ลัดจากดรอปดาวน์ที่เปิดหลังจากดับเบิลคลิก

7 - กดปุ่มทางลัดบนแป้นพิมพ์

8 - ไปที่โค้ดของคุณและที่ที่คุณต้องการเพิ่มความคิดเห็นกดปุ่มทางลัด

9 - สนุก!

เพียงเลือกเวอร์ชันของ Eclipse ของปุ่มกดในการตั้งค่า Keymap Eclipse Keymap รวมอยู่ใน Android Studio

ฉันไม่แน่ใจว่าฉันเข้าใจคำถามทั้งหมด แต่สามารถดูรายการแป้นพิมพ์ลัดที่นี่ - หวังว่านี่จะช่วยได้!

Android Studio -> Preferences -> Editor -> Intentions -> Java -> Declaration -> เปิดใช้งาน "Add JavaDoc"

และในขณะที่เลือกวิธีการใช้งาน (Ctrl / Cmd + i) ที่ด้านล่างซ้ายคุณควรเห็นช่องทำเครื่องหมายเพื่อเปิดใช้งานคัดลอก JavaDoc

ฉันแนะนำDokkaสำหรับยีน javadoc พร้อมความคิดเห็นและอื่น ๆ

ALT+ SHIFT+ Gจะสร้างความคิดเห็นที่สร้างขึ้นอัตโนมัติสำหรับวิธีการของคุณ (วางเคอร์เซอร์ที่ตำแหน่งเริ่มต้นของวิธีการของคุณ)