Chuỗi tài liệu Python trực tuyến

Để tắt tạo kiểu trong tài liệu, hãy sử dụng mẫu

{{#args}}                       - iterate over function arguments
    {{var}}                     - variable name
    {{typePlaceholder}}         - _type_ or guessed type  placeholder
    {{descriptionPlaceholder}}  - _description_ placeholder
{{/args}}

{{#kwargs}}                     - iterate over function kwargs
    {{var}}                     - variable name
    {{typePlaceholder}}         - _type_ or guessed type placeholder
    {{&default}}                - default value (& unescapes the variable)
    {{descriptionPlaceholder}}  - _description_ placeholder
{{/kwargs}}

{{#exceptions}}                 - iterate over exceptions
    {{type}}                    - exception type
    {{descriptionPlaceholder}}  - _description_ placeholder
{{/exceptions}}

{{#yields}}                     - iterate over yields
    {{typePlaceholder}}         - _type_ placeholder
    {{descriptionPlaceholder}}  - _description_ placeholder
{{/yields}}

{{#returns}}                    - iterate over returns
    {{typePlaceholder}}         - _type_ placeholder
    {{descriptionPlaceholder}}  - _description_ placeholder
{{/returns}}

Cách sử dụng

Con trỏ phải nằm trên dòng ngay bên dưới định nghĩa để tạo chuỗi tài liệu được điền tự động đầy đủ

• Nhấn enter sau khi mở chuỗi tài liệu có ba dấu ngoặc kép (có thể định cấu hình

  {{#args}}                       - iterate over function arguments
      {{var}}                     - variable name
      {{typePlaceholder}}         - _type_ or guessed type  placeholder
      {{descriptionPlaceholder}}  - _description_ placeholder
  {{/args}}
  
  {{#kwargs}}                     - iterate over function kwargs
      {{var}}                     - variable name
      {{typePlaceholder}}         - _type_ or guessed type placeholder
      {{&default}}                - default value (& unescapes the variable)
      {{descriptionPlaceholder}}  - _description_ placeholder
  {{/kwargs}}
  
  {{#exceptions}}                 - iterate over exceptions
      {{type}}                    - exception type
      {{descriptionPlaceholder}}  - _description_ placeholder
  {{/exceptions}}
  
  {{#yields}}                     - iterate over yields
      {{typePlaceholder}}         - _type_ placeholder
      {{descriptionPlaceholder}}  - _description_ placeholder
  {{/yields}}
  
  {{#returns}}                    - iterate over returns
      {{typePlaceholder}}         - _type_ placeholder
      {{descriptionPlaceholder}}  - _description_ placeholder
  {{/returns}}
  

  3 hoặc

  {{#args}}                       - iterate over function arguments
      {{var}}                     - variable name
      {{typePlaceholder}}         - _type_ or guessed type  placeholder
      {{descriptionPlaceholder}}  - _description_ placeholder
  {{/args}}
  
  {{#kwargs}}                     - iterate over function kwargs
      {{var}}                     - variable name
      {{typePlaceholder}}         - _type_ or guessed type placeholder
      {{&default}}                - default value (& unescapes the variable)
      {{descriptionPlaceholder}}  - _description_ placeholder
  {{/kwargs}}
  
  {{#exceptions}}                 - iterate over exceptions
      {{type}}                    - exception type
      {{descriptionPlaceholder}}  - _description_ placeholder
  {{/exceptions}}
  
  {{#yields}}                     - iterate over yields
      {{typePlaceholder}}         - _type_ placeholder
      {{descriptionPlaceholder}}  - _description_ placeholder
  {{/yields}}
  
  {{#returns}}                    - iterate over returns
      {{typePlaceholder}}         - _type_ placeholder
      {{descriptionPlaceholder}}  - _description_ placeholder
  {{/returns}}
  

  4)
• Phim tăt.

  {{#args}}                       - iterate over function arguments
      {{var}}                     - variable name
      {{typePlaceholder}}         - _type_ or guessed type  placeholder
      {{descriptionPlaceholder}}  - _description_ placeholder
  {{/args}}
  
  {{#kwargs}}                     - iterate over function kwargs
      {{var}}                     - variable name
      {{typePlaceholder}}         - _type_ or guessed type placeholder
      {{&default}}                - default value (& unescapes the variable)
      {{descriptionPlaceholder}}  - _description_ placeholder
  {{/kwargs}}
  
  {{#exceptions}}                 - iterate over exceptions
      {{type}}                    - exception type
      {{descriptionPlaceholder}}  - _description_ placeholder
  {{/exceptions}}
  
  {{#yields}}                     - iterate over yields
      {{typePlaceholder}}         - _type_ placeholder
      {{descriptionPlaceholder}}  - _description_ placeholder
  {{/yields}}
  
  {{#returns}}                    - iterate over returns
      {{typePlaceholder}}         - _type_ placeholder
      {{descriptionPlaceholder}}  - _description_ placeholder
  {{/returns}}
  

  5 hoặc

  {{#args}}                       - iterate over function arguments
      {{var}}                     - variable name
      {{typePlaceholder}}         - _type_ or guessed type  placeholder
      {{descriptionPlaceholder}}  - _description_ placeholder
  {{/args}}
  
  {{#kwargs}}                     - iterate over function kwargs
      {{var}}                     - variable name
      {{typePlaceholder}}         - _type_ or guessed type placeholder
      {{&default}}                - default value (& unescapes the variable)
      {{descriptionPlaceholder}}  - _description_ placeholder
  {{/kwargs}}
  
  {{#exceptions}}                 - iterate over exceptions
      {{type}}                    - exception type
      {{descriptionPlaceholder}}  - _description_ placeholder
  {{/exceptions}}
  
  {{#yields}}                     - iterate over yields
      {{typePlaceholder}}         - _type_ placeholder
      {{descriptionPlaceholder}}  - _description_ placeholder
  {{/yields}}
  
  {{#returns}}                    - iterate over returns
      {{typePlaceholder}}         - _type_ placeholder
      {{descriptionPlaceholder}}  - _description_ placeholder
  {{/returns}}
  

  6 cho mac
  • Có thể thay đổi trong Tùy chọn -> Phím tắt -> tiện ích mở rộng. tạo chuỗi tài liệu
• Yêu cầu.

  {{#args}}                       - iterate over function arguments
      {{var}}                     - variable name
      {{typePlaceholder}}         - _type_ or guessed type  placeholder
      {{descriptionPlaceholder}}  - _description_ placeholder
  {{/args}}
  
  {{#kwargs}}                     - iterate over function kwargs
      {{var}}                     - variable name
      {{typePlaceholder}}         - _type_ or guessed type placeholder
      {{&default}}                - default value (& unescapes the variable)
      {{descriptionPlaceholder}}  - _description_ placeholder
  {{/kwargs}}
  
  {{#exceptions}}                 - iterate over exceptions
      {{type}}                    - exception type
      {{descriptionPlaceholder}}  - _description_ placeholder
  {{/exceptions}}
  
  {{#yields}}                     - iterate over yields
      {{typePlaceholder}}         - _type_ placeholder
      {{descriptionPlaceholder}}  - _description_ placeholder
  {{/yields}}
  
  {{#returns}}                    - iterate over returns
      {{typePlaceholder}}         - _type_ placeholder
      {{descriptionPlaceholder}}  - _description_ placeholder
  {{/returns}}
  

  7
• menu nhấp chuột phải.

  {{#args}}                       - iterate over function arguments
      {{var}}                     - variable name
      {{typePlaceholder}}         - _type_ or guessed type  placeholder
      {{descriptionPlaceholder}}  - _description_ placeholder
  {{/args}}
  
  {{#kwargs}}                     - iterate over function kwargs
      {{var}}                     - variable name
      {{typePlaceholder}}         - _type_ or guessed type placeholder
      {{&default}}                - default value (& unescapes the variable)
      {{descriptionPlaceholder}}  - _description_ placeholder
  {{/kwargs}}
  
  {{#exceptions}}                 - iterate over exceptions
      {{type}}                    - exception type
      {{descriptionPlaceholder}}  - _description_ placeholder
  {{/exceptions}}
  
  {{#yields}}                     - iterate over yields
      {{typePlaceholder}}         - _type_ placeholder
      {{descriptionPlaceholder}}  - _description_ placeholder
  {{/yields}}
  
  {{#returns}}                    - iterate over returns
      {{typePlaceholder}}         - _type_ placeholder
      {{descriptionPlaceholder}}  - _description_ placeholder
  {{/returns}}
  

  7

Thiêt lập mở rộng

Tiện ích mở rộng này đóng góp các cài đặt sau

• {{#args}}                       - iterate over function arguments
      {{var}}                     - variable name
      {{typePlaceholder}}         - _type_ or guessed type  placeholder
      {{descriptionPlaceholder}}  - _description_ placeholder
  {{/args}}
  
  {{#kwargs}}                     - iterate over function kwargs
      {{var}}                     - variable name
      {{typePlaceholder}}         - _type_ or guessed type placeholder
      {{&default}}                - default value (& unescapes the variable)
      {{descriptionPlaceholder}}  - _description_ placeholder
  {{/kwargs}}
  
  {{#exceptions}}                 - iterate over exceptions
      {{type}}                    - exception type
      {{descriptionPlaceholder}}  - _description_ placeholder
  {{/exceptions}}
  
  {{#yields}}                     - iterate over yields
      {{typePlaceholder}}         - _type_ placeholder
      {{descriptionPlaceholder}}  - _description_ placeholder
  {{/yields}}
  
  {{#returns}}                    - iterate over returns
      {{typePlaceholder}}         - _type_ placeholder
      {{descriptionPlaceholder}}  - _description_ placeholder
  {{/returns}}
  

  0. Chuyển đổi giữa các định dạng chuỗi tài liệu khác nhau

• {{#args}}                       - iterate over function arguments
      {{var}}                     - variable name
      {{typePlaceholder}}         - _type_ or guessed type  placeholder
      {{descriptionPlaceholder}}  - _description_ placeholder
  {{/args}}
  
  {{#kwargs}}                     - iterate over function kwargs
      {{var}}                     - variable name
      {{typePlaceholder}}         - _type_ or guessed type placeholder
      {{&default}}                - default value (& unescapes the variable)
      {{descriptionPlaceholder}}  - _description_ placeholder
  {{/kwargs}}
  
  {{#exceptions}}                 - iterate over exceptions
      {{type}}                    - exception type
      {{descriptionPlaceholder}}  - _description_ placeholder
  {{/exceptions}}
  
  {{#yields}}                     - iterate over yields
      {{typePlaceholder}}         - _type_ placeholder
      {{descriptionPlaceholder}}  - _description_ placeholder
  {{/yields}}
  
  {{#returns}}                    - iterate over returns
      {{typePlaceholder}}         - _type_ placeholder
      {{descriptionPlaceholder}}  - _description_ placeholder
  {{/returns}}
  

  1. Đường dẫn đến mẫu chuỗi tài liệu tùy chỉnh (tuyệt đối hoặc liên quan đến thư mục gốc của dự án)

• {{#args}}                       - iterate over function arguments
      {{var}}                     - variable name
      {{typePlaceholder}}         - _type_ or guessed type  placeholder
      {{descriptionPlaceholder}}  - _description_ placeholder
  {{/args}}
  
  {{#kwargs}}                     - iterate over function kwargs
      {{var}}                     - variable name
      {{typePlaceholder}}         - _type_ or guessed type placeholder
      {{&default}}                - default value (& unescapes the variable)
      {{descriptionPlaceholder}}  - _description_ placeholder
  {{/kwargs}}
  
  {{#exceptions}}                 - iterate over exceptions
      {{type}}                    - exception type
      {{descriptionPlaceholder}}  - _description_ placeholder
  {{/exceptions}}
  
  {{#yields}}                     - iterate over yields
      {{typePlaceholder}}         - _type_ placeholder
      {{descriptionPlaceholder}}  - _description_ placeholder
  {{/yields}}
  
  {{#returns}}                    - iterate over returns
      {{typePlaceholder}}         - _type_ placeholder
      {{descriptionPlaceholder}}  - _description_ placeholder
  {{/returns}}
  

  2. Tạo chuỗi tài liệu khi nhấn enter sau khi mở chuỗi tài liệu

• {{#args}}                       - iterate over function arguments
      {{var}}                     - variable name
      {{typePlaceholder}}         - _type_ or guessed type  placeholder
      {{descriptionPlaceholder}}  - _description_ placeholder
  {{/args}}
  
  {{#kwargs}}                     - iterate over function kwargs
      {{var}}                     - variable name
      {{typePlaceholder}}         - _type_ or guessed type placeholder
      {{&default}}                - default value (& unescapes the variable)
      {{descriptionPlaceholder}}  - _description_ placeholder
  {{/kwargs}}
  
  {{#exceptions}}                 - iterate over exceptions
      {{type}}                    - exception type
      {{descriptionPlaceholder}}  - _description_ placeholder
  {{/exceptions}}
  
  {{#yields}}                     - iterate over yields
      {{typePlaceholder}}         - _type_ placeholder
      {{descriptionPlaceholder}}  - _description_ placeholder
  {{/yields}}
  
  {{#returns}}                    - iterate over returns
      {{typePlaceholder}}         - _type_ placeholder
      {{descriptionPlaceholder}}  - _description_ placeholder
  {{/returns}}
  

  3. Bao gồm phần tóm tắt mở rộng trong chuỗi tài liệu

• {{#args}}                       - iterate over function arguments
      {{var}}                     - variable name
      {{typePlaceholder}}         - _type_ or guessed type  placeholder
      {{descriptionPlaceholder}}  - _description_ placeholder
  {{/args}}
  
  {{#kwargs}}                     - iterate over function kwargs
      {{var}}                     - variable name
      {{typePlaceholder}}         - _type_ or guessed type placeholder
      {{&default}}                - default value (& unescapes the variable)
      {{descriptionPlaceholder}}  - _description_ placeholder
  {{/kwargs}}
  
  {{#exceptions}}                 - iterate over exceptions
      {{type}}                    - exception type
      {{descriptionPlaceholder}}  - _description_ placeholder
  {{/exceptions}}
  
  {{#yields}}                     - iterate over yields
      {{typePlaceholder}}         - _type_ placeholder
      {{descriptionPlaceholder}}  - _description_ placeholder
  {{/yields}}
  
  {{#returns}}                    - iterate over returns
      {{typePlaceholder}}         - _type_ placeholder
      {{descriptionPlaceholder}}  - _description_ placeholder
  {{/returns}}
  

  4. Bao gồm tên hàm khi bắt đầu chuỗi tài liệu

• {{#args}}                       - iterate over function arguments
      {{var}}                     - variable name
      {{typePlaceholder}}         - _type_ or guessed type  placeholder
      {{descriptionPlaceholder}}  - _description_ placeholder
  {{/args}}
  
  {{#kwargs}}                     - iterate over function kwargs
      {{var}}                     - variable name
      {{typePlaceholder}}         - _type_ or guessed type placeholder
      {{&default}}                - default value (& unescapes the variable)
      {{descriptionPlaceholder}}  - _description_ placeholder
  {{/kwargs}}
  
  {{#exceptions}}                 - iterate over exceptions
      {{type}}                    - exception type
      {{descriptionPlaceholder}}  - _description_ placeholder
  {{/exceptions}}
  
  {{#yields}}                     - iterate over yields
      {{typePlaceholder}}         - _type_ placeholder
      {{descriptionPlaceholder}}  - _description_ placeholder
  {{/yields}}
  
  {{#returns}}                    - iterate over returns
      {{typePlaceholder}}         - _type_ placeholder
      {{descriptionPlaceholder}}  - _description_ placeholder
  {{/returns}}
  

  5. Dòng mới trước trình giữ chỗ tóm tắt

• {{#args}}                       - iterate over function arguments
      {{var}}                     - variable name
      {{typePlaceholder}}         - _type_ or guessed type  placeholder
      {{descriptionPlaceholder}}  - _description_ placeholder
  {{/args}}
  
  {{#kwargs}}                     - iterate over function kwargs
      {{var}}                     - variable name
      {{typePlaceholder}}         - _type_ or guessed type placeholder
      {{&default}}                - default value (& unescapes the variable)
      {{descriptionPlaceholder}}  - _description_ placeholder
  {{/kwargs}}
  
  {{#exceptions}}                 - iterate over exceptions
      {{type}}                    - exception type
      {{descriptionPlaceholder}}  - _description_ placeholder
  {{/exceptions}}
  
  {{#yields}}                     - iterate over yields
      {{typePlaceholder}}         - _type_ placeholder
      {{descriptionPlaceholder}}  - _description_ placeholder
  {{/yields}}
  
  {{#returns}}                    - iterate over returns
      {{typePlaceholder}}         - _type_ placeholder
      {{descriptionPlaceholder}}  - _description_ placeholder
  {{/returns}}
  

  6. Suy ra các loại từ gợi ý loại, giá trị mặc định và tên biến

• {{#args}}                       - iterate over function arguments
      {{var}}                     - variable name
      {{typePlaceholder}}         - _type_ or guessed type  placeholder
      {{descriptionPlaceholder}}  - _description_ placeholder
  {{/args}}
  
  {{#kwargs}}                     - iterate over function kwargs
      {{var}}                     - variable name
      {{typePlaceholder}}         - _type_ or guessed type placeholder
      {{&default}}                - default value (& unescapes the variable)
      {{descriptionPlaceholder}}  - _description_ placeholder
  {{/kwargs}}
  
  {{#exceptions}}                 - iterate over exceptions
      {{type}}                    - exception type
      {{descriptionPlaceholder}}  - _description_ placeholder
  {{/exceptions}}
  
  {{#yields}}                     - iterate over yields
      {{typePlaceholder}}         - _type_ placeholder
      {{descriptionPlaceholder}}  - _description_ placeholder
  {{/yields}}
  
  {{#returns}}                    - iterate over returns
      {{typePlaceholder}}         - _type_ placeholder
      {{descriptionPlaceholder}}  - _description_ placeholder
  {{/returns}}
  

  7. Phong cách trích dẫn cho docstrings

Mẫu chuỗi tài liệu tùy chỉnh

Tiện ích mở rộng này hiện hỗ trợ các mẫu tùy chỉnh. Tiện ích mở rộng sử dụng bộ ria mép. công cụ tạo khuôn mẫu js. Để sử dụng một mẫu tùy chỉnh, hãy tạo một. ria mép và chỉ định đường dẫn của nó bằng cách sử dụng cấu hình

{{#args}}                       - iterate over function arguments
    {{var}}                     - variable name
    {{typePlaceholder}}         - _type_ or guessed type  placeholder
    {{descriptionPlaceholder}}  - _description_ placeholder
{{/args}}

{{#kwargs}}                     - iterate over function kwargs
    {{var}}                     - variable name
    {{typePlaceholder}}         - _type_ or guessed type placeholder
    {{&default}}                - default value (& unescapes the variable)
    {{descriptionPlaceholder}}  - _description_ placeholder
{{/kwargs}}

{{#exceptions}}                 - iterate over exceptions
    {{type}}                    - exception type
    {{descriptionPlaceholder}}  - _description_ placeholder
{{/exceptions}}

{{#yields}}                     - iterate over yields
    {{typePlaceholder}}         - _type_ placeholder
    {{descriptionPlaceholder}}  - _description_ placeholder
{{/yields}}

{{#returns}}                    - iterate over returns
    {{typePlaceholder}}         - _type_ placeholder
    {{descriptionPlaceholder}}  - _description_ placeholder
{{/returns}}

Biến

{{name}}                        - name of the function
{{summaryPlaceholder}}          - _summary_ placeholder
{{extendedSummaryPlaceholder}}  - [extended_summary] placeholder

phần

{{#args}}                       - iterate over function arguments
    {{var}}                     - variable name
    {{typePlaceholder}}         - _type_ or guessed type  placeholder
    {{descriptionPlaceholder}}  - _description_ placeholder
{{/args}}

{{#kwargs}}                     - iterate over function kwargs
    {{var}}                     - variable name
    {{typePlaceholder}}         - _type_ or guessed type placeholder
    {{&default}}                - default value (& unescapes the variable)
    {{descriptionPlaceholder}}  - _description_ placeholder
{{/kwargs}}

{{#exceptions}}                 - iterate over exceptions
    {{type}}                    - exception type
    {{descriptionPlaceholder}}  - _description_ placeholder
{{/exceptions}}

{{#yields}}                     - iterate over yields
    {{typePlaceholder}}         - _type_ placeholder
    {{descriptionPlaceholder}}  - _description_ placeholder
{{/yields}}

{{#returns}}                    - iterate over returns
    {{typePlaceholder}}         - _type_ placeholder
    {{descriptionPlaceholder}}  - _description_ placeholder
{{/returns}}

Phần bổ sung

{{#args}}                       - iterate over function arguments
    {{var}}                     - variable name
    {{typePlaceholder}}         - _type_ or guessed type  placeholder
    {{descriptionPlaceholder}}  - _description_ placeholder
{{/args}}

{{#kwargs}}                     - iterate over function kwargs
    {{var}}                     - variable name
    {{typePlaceholder}}         - _type_ or guessed type placeholder
    {{&default}}                - default value (& unescapes the variable)
    {{descriptionPlaceholder}}  - _description_ placeholder
{{/kwargs}}

{{#exceptions}}                 - iterate over exceptions
    {{type}}                    - exception type
    {{descriptionPlaceholder}}  - _description_ placeholder
{{/exceptions}}

{{#yields}}                     - iterate over yields
    {{typePlaceholder}}         - _type_ placeholder
    {{descriptionPlaceholder}}  - _description_ placeholder
{{/yields}}

{{#returns}}                    - iterate over returns
    {{typePlaceholder}}         - _type_ placeholder
    {{descriptionPlaceholder}}  - _description_ placeholder
{{/returns}}

Nhật ký thay đổi

Kiểm tra THAY ĐỔI. md cho mọi thay đổi phiên bản

Vấn đề báo cáo

Báo cáo bất kỳ vấn đề nào trên trang vấn đề của github. Làm theo mẫu và thêm càng nhiều thông tin càng tốt

Đóng góp

Mã nguồn của tiện ích mở rộng này được lưu trữ trên GitHub. Đóng góp, yêu cầu kéo, đề xuất và báo cáo lỗi được đánh giá cao