Cách tạo bình luận javadoc trong Android Studio


204

Tôi có thể sử dụng các phím tắt trong studio Android để tạo bình luận javadoc không?

Nếu không, cách dễ nhất để tạo bình luận javadoc là gì?


Câu hỏi này là 50/50. Bạn cũng không tìm kiếm các khối javadoc duy nhất để tạo javadoc trong toàn bộ tài liệu. Đó là cái gì
K - Độc tính trong SO đang tăng lên.

ALTR + ENTER hiển thị chế độ xem bạn có thể tạo nhận xét về các phương thức đã khai báo.
Zala Janaksinh

Có thể bạn nên thêm một mẫu Live (studio Android - cài đặt - trình chỉnh sửa - Mẫu trực tiếp - thêm) cho nó. Trong trường văn bản mẫu thêm văn bản sau. / ** * $ bình luận $ * /
Johnett Mathew

Câu trả lời:


388

Tôi không thể tìm thấy bất kỳ phím tắt nào để tạo bình luận javadoc. Nhưng nếu bạn nhập /**trước khi khai báo phương thức và nhấn Enter, khối nhận xét javadoc sẽ được tạo tự động.

Đọc này để biết thêm thông tin.


7
Thật xấu hổ vì điều này cũng không hoạt động để tạo bình luận javadoc cho các lớp, trường, v.v. Nó sẽ còn đẹp hơn nếu nó tạo javadoc từ một mẫu có thể tùy chỉnh.
Ted Hopp

23
tất nhiên nó có phím tắt: vị trí trên tên phương thức / hàm tạo và nhấn alt + enter, chọn tạo javadoc từ menu
Ewoks

tham khảo này thêm về giải pháp trên
Pritesh Vishwakarma

110

Để tạo bình luận, gõ /**phím trước khi khai báo phương thức và nhấn Enter. Nó sẽ tạo ra bình luận javadoc.

Thí dụ:

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

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

Để biết thêm thông tin, hãy kiểm tra liên kết https://www.jetbrains.com/idea/features/javadoc.html


4
@sediteshwaran - thật sao? Đó là câu trả lời giống như câu trả lời từ DouO (câu trả lời gốc), ngoại trừ nó có một ví dụ. Ngay cả các liên kết là một bản sao. Ví dụ nên được thêm vào câu trả lời ban đầu.
CJBS

3
@sediteshwaran - đối với những gì đáng giá, tôi có thể thấy rằng chỉ cần xem ví dụ về các nhận xét (trong câu trả lời) là hữu ích, khi một người muốn có câu trả lời nhanh chóng ;-)
CJBS

Trên thực tế, ví dụ thiếu dấu * trước lần cuối /
Maximiliano Ambrosini

35

Dưới đây là một ví dụ về nhận xét JavaDoc từ 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;
        }
 }

Định dạng cơ bản có thể được tạo tự động theo một trong các cách sau:

  • Định vị con trỏ phía trên phương thức và gõ /**+Enter
  • Định vị con trỏ trên tên phương thức và nhấn Alt+ Enter> bấm Thêm JavaDoc nhập mô tả hình ảnh ở đây

17

Bạn có thể cài đặt plugin JavaDoc từ Cài đặt-> Plugin-> Duyệt các kho lưu trữ.

lấy tài liệu plugin từ liên kết dưới đây

Tài liệu plugin JavaDoc

nhập mô tả hình ảnh ở đây


Điều này làm việc tuyệt vời. Cài đặt plugin JavaDoc (như trên), sau đó nhấn CNTL + SHIFT + ALT + G.
Alan Nelson

10

Bạn có thể sử dụng kiểu nhật thực của việc tạo bình luận JavaDoc thông qua "Sửa bình luận tài liệu". Mở "Ưu tiên" -> "Sơ đồ bàn phím" và gán hành động "Khắc phục nhận xét tài liệu" cho một khóa mà bạn muốn.


9

Ở đây chúng ta có thể một số thứ như thế này. Và thay vì sử dụng bất kỳ phím tắt nào, chúng ta có thể viết bình luận "mặc định" ở cấp độ lớp / gói / dự án. Và sửa đổi theo yêu cầu

   *** 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.

Ưu điểm là, bạn có thể tạo khối nhận xét cho all the methods at a time.


9

Nhận xét Javadoc có thể được tự động thêm vào bằng cách sử dụng tính năng tự động hoàn thành IDE của bạn. Hãy thử gõ /**và nhấn Enterđể tạo một nhận xét Javadoc mẫu.

 /**
 *
 * @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
 */

5

Trong Android Studio, bạn không cần trình cắm. Trên máy Mac, chỉ cần mở Android Studio -> nhấp vào Android Studio ở thanh trên cùng -> nhấp vào Prefrences -> tìm Tệp và Mã mẫu trong danh sách -> chọn bao gồm -> xây dựng nó và sẽ kiên trì trong tất cả các dự án của bạn


2
  • Một cách khác để thêm nhận xét tài liệu java là nhấn: Ctrl + Shift + A >> hiển thị cửa sổ bật lên >> loại: Thêm javadocs >> Enter.

  • Ctrl + Áo + A: Tra cứu lệnh (tên lệnh tự động hoàn thành)

nhập mô tả hình ảnh ở đây


2

Chỉ cần chọn (tức là nhấp) tên phương thức, sau đó sử dụng tổ hợp phím Alt + Enter, chọn "Thêm JavaDoc"

Điều này giả định rằng bạn chưa thêm nhận xét nào trên phương thức, nếu không, tùy chọn "Thêm JavaDoc" sẽ không xuất hiện.


2

Trong studio Android, chúng tôi có một số cách để tự động tạo nhận xét:

  • Phương pháp I:

Bằng cách nhập / ** và sau đó nhấn Enter, bạn có thể tạo dòng nhận xét tiếp theo và nó sẽ tự động tạo các thông số, v.v. nhưng khi bạn cần phím nóng cho phương thức kiểm tra II này bên dưới.

  • ** Cách II: **

1 - Goto topMothy

2 - Tệp> Cài đặt

3 - Chọn Keymap từ cài đặt

4 - Trên thanh tìm kiếm trên cùng bên phải tìm kiếm "Fix Doc"

5 - Chọn "sửa bình luận tài liệu" từ kết quả và nhấp đúp vào nó

6 - Chọn Thêm phím tắt từ trình đơn thả xuống đã mở sau khi nhấp đúp

7 - Nhấn các phím tắt trên bàn phím

8 - Xem mã của bạn và nơi bạn muốn thêm một số nhận xét, nhấn phím tắt

9 - Tận hưởng!


Cách thuận tiện nhất để thêm tài liệu. Ví dụ: tôi đã gán "'" và Enter làm phím tắt
CodeToLife

1

Chỉ cần chọn phiên bản Eclipse của keycap trong cài đặt Keymap. Một Keymap Eclipse được bao gồm trong Android Studio.


0

Tôi không chắc là tôi hoàn toàn hiểu câu hỏi, nhưng một danh sách các phím tắt bàn phím có thể được tìm thấy ở đây - Hy vọng điều này sẽ giúp!


2
Trong nhật thực để thêm nhận xét javadoc, nhấn Alt + shift + j, nhưng trong AndroidStudio nhưng tôi không biết cách thực hiện
qinxianyuzou

Nếu tôi nhớ lại, lối tắt đó chỉ hoạt động nếu bạn đã cài đặt và bật plugin 'jautodoc'.
Matt

0

Android Studio -> Tùy chọn -> Trình chỉnh sửa -> Ý định -> Java -> Tuyên bố -> Bật "Thêm JavaDoc"

Và, trong khi chọn Phương thức để triển khai (Ctrl / Cmd + i), ở phía dưới bên trái, bạn sẽ thấy hộp kiểm để bật Sao chép JavaDoc.



-5

ALT+ SHIFT+ Gsẽ tạo các nhận xét được tạo tự động cho phương thức của bạn (đặt con trỏ ở vị trí bắt đầu của phương thức của bạn).


public void hidePal () u nên đặt con trỏ trước công chúng và thử nó hoặc vui lòng kiểm tra xem bạn đã cài đặt tài liệu java trong studio của bạn chưa.
Dinesh IT

Nó cũng không làm việc cho tôi. Có lẽ, nó đang làm việc trong một số sơ đồ đặc biệt. Sơ đồ bàn phím có thể được cấu hình trong Tùy chọn> Sơ đồ bàn phím. Hoặc sơ đồ đã được chỉnh sửa.
Oliver Kranz
Khi sử dụng trang web của chúng tôi, bạn xác nhận rằng bạn đã đọc và hiểu Chính sách cookieChính sách bảo mật của chúng tôi.
Licensed under cc by-sa 3.0 with attribution required.