Trình tạo chuỗi tài liệu python là gì?

Trưởng phòng Dữ liệu @ Sephora. RecSys. DE. NLP. sơ yếu lý lịch. GCP. AWS. Tìm kiếm thần kinh. MLOps. AI tập trung vào dữ liệu. DS hướng dẫn. nhà văn

• Báo cáo bài viết này

  Bài báo cáo

  Bài báo cáo

  Quay lại Gửi

Chuỗi tài liệu Python là một chuỗi được sử dụng để mô tả một mô-đun, lớp, chức năng hoặc phương thức Python bằng tiếng Anh đơn giản để người đọc có thể hiểu chức năng của nó mà không cần phải đọc chi tiết về cách triển khai. Nó cũng thường được sử dụng để tự động tạo tài liệu được xuất bản trên web bằng công cụ như Sphinx [https. //lnkd. in/gp6FA7g] Tôi viết mã rất nhiều trong VSCode và dành khá nhiều thời gian để viết các chuỗi tài liệu cho các chức năng của mình. Hãy tưởng tượng sự hiển linh của tôi ngày hôm qua khi tôi đọc bài đăng của Tiến sĩ Jesper Dramsch (liên kết trong nhận xét) có đề cập đến tiện ích mở rộng VSCode bên dưới để tự động tạo chuỗi tài liệu. OMG, cuộc sống của tôi sẽ dễ dàng hơn rất nhiều nếu tôi tình cờ gặp tiện ích mở rộng này sớm hơn. Nếu bạn sử dụng VSCode để phát triển Python, tôi khuyên bạn nên kiểm tra tiện ích mở rộng này để cải thiện năng suất chuỗi tài liệu của mình. Bạn có biết bất kỳ hack năng suất lập trình nào khác không? . #python #lập trình #năng suất #vscode #datascience #dataanalytics #công nghệ #phát triển

Patrick Loeber · · · · · Ngày 14 tháng 8 năm 2020 · 4 phút đọc

Visual Studio Code (VS Code) là trình chỉnh sửa mã nguồn miễn phí do Microsoft tạo ra và có sẵn cho Windows, Linux và macOS. Bạn có thể tải về tại đây. https. //mã số. Visual Studio. com/

Trình chỉnh sửa có thể được mở rộng thông qua Tiện ích mở rộng, có sẵn thông qua kho lưu trữ trung tâm. Điều này bao gồm các bổ sung cho trình chỉnh sửa và hỗ trợ ngôn ngữ. Một tính năng đáng chú ý là khả năng tạo các tiện ích mở rộng bổ sung hỗ trợ cho các ngôn ngữ, chủ đề và trình gỡ lỗi mới, thực hiện phân tích mã tĩnh và thêm các đoạn mã. Trong hướng dẫn này, tôi chỉ cho bạn thiết lập Trực quan tối thiểu của tôi cho Lập trình Python. Tôi chỉ sử dụng 5 Tiện ích mở rộng. Nó đơn giản nhưng cho phép tôi làm việc thực sự hiệu quả

1. Tiện ích mở rộng Python chính thức của Microsoft¶

liên kết. https. //thương trường. Visual Studio. com/items?itemName=ms-python. con trăn

Tiện ích mở rộng Visual Studio Code có hỗ trợ phong phú cho ngôn ngữ Python (dành cho tất cả các phiên bản ngôn ngữ được hỗ trợ tích cực. 2. 7, >=3. 5), bao gồm các tính năng như IntelliSense, linting, gỡ lỗi, điều hướng mã, định dạng mã, hỗ trợ máy tính xách tay Jupyter, tái cấu trúc, trình khám phá biến, trình khám phá thử nghiệm, đoạn trích, v.v.

2. Trình tạo chuỗi tài liệu Python¶

liên kết. https. //thương trường. Visual Studio. com/items?itemName=njpwerner. chuỗi tự động

Tiện ích mở rộng Visual Studio Code để tạo nhanh các chuỗi tài liệu cho các hàm python

Đặc trưng

• Nhanh chóng tạo một đoạn mã docstring có thể được gắn thẻ thông qua
• Chọn giữa một số loại định dạng chuỗi tài liệu khác nhau
• Suy ra các loại tham số thông qua gợi ý loại pep 484, giá trị mặc định và tên var
• Hỗ trợ cho các đối số, kwargs, trang trí, lỗi và các loại tham số

Cách sử dụng. Viết hàm trước, sau đó đi đến đầu hàm và gõ ba dấu ngoặc kép ("""). Sau đó nhấn enter và bạn nhận được một chuỗi tài liệu đã chứa các biến đầu vào và trả về. Bạn chỉ cần điền vào những phần còn thiếu. Bạn có thể dễ dàng chuyển sang phần còn thiếu tiếp theo bằng cách nhấn Tab

def function(a, b=5):
"""[summary]

Args:
    a ([type]): [description]
    b (int, optional): [description]. Defaults to 5.

Returns:
    [type]: [description]
"""
if a == -1:
    print('negative')

result = a * b
return result

3. Thụt lề Python¶

liên kết. https. //thương trường. Visual Studio. com/items?itemName=KevinRose. vsc-python-thụt lề

Nhận thụt đầu dòng chính xác khi bạn nhấn Enter. Không hơn không kém. Nhưng nó thực sự có thể giúp bạn tiết kiệm rất nhiều thời gian khi viết mã

data = {'a': 0,
        'b': 1,
        'c': 2}


def function(first,
             second)

4. Người chạy mã¶

liên kết. https. //thương trường. Visual Studio. com/items?itemName=formulahendry. người chạy mã

Chạy tệp mã của bạn hoặc chỉ các đoạn mã bằng cách cắt ngắn. Không chỉ hỗ trợ Python mà còn nhiều ngôn ngữ

Đặc trưng

Tập quán

• Để chạy mã

  • sử dụng phím tắt Ctrl+Alt+N
  • hoặc nhấn F1 rồi chọn/gõ Run Code,
  • hoặc nhấp chuột phải vào Trình soạn thảo văn bản rồi nhấp vào Chạy mã trong trình đơn ngữ cảnh của trình soạn thảo
  • hoặc nhấp vào nút Chạy mã trong menu tiêu đề trình chỉnh sửa
  • hoặc nhấp vào nút Run Code trong menu ngữ cảnh của trình duyệt tệp

• Để dừng mã đang chạy

  • sử dụng phím tắt Ctrl+Alt+M
  • hoặc nhấn F1 rồi chọn/gõ Stop Code Run
  • hoặc nhấp chuột phải vào Kênh đầu ra và sau đó nhấp vào Dừng chạy mã trong menu ngữ cảnh

5. vải lót¶

Lint, hay kẻ nói dối, là một công cụ phân tích mã nguồn để gắn cờ các lỗi lập trình, lỗi, lỗi văn phong và các cấu trúc đáng ngờ. Nó giúp bạn giảm lỗi trong khi vẫn viết mã và đảm bảo bạn tuân thủ Hướng dẫn về Phong cách

Trình nói dối không được cài đặt thông qua thư viện Tiện ích mở rộng mà phải được cài đặt vào gói trang web của bạn bằng trình cài đặt gói như pip. Bạn có thể tìm kiếm trong Bảng lệnh cho Select Linter, rồi chọn cái bạn thích. Tôi khuyên bạn nên sử dụng pylint hoặc flake8, đây là những cái phổ biến nhất. Chọn mục nhập và bạn có thể nhận được thông báo bật lên rằng linting chưa được cài đặt. Hãy tiếp tục và nhấp vào Cài đặt, thao tác này sẽ cài đặt kẻ nói dối đã chọn với pip

Bây giờ khi bạn bắt đầu viết mã và mắc lỗi hoặc lỗi văn phong, bạn sẽ thấy các gợi ý màu cam hoặc đỏ bên cạnh mã có thể sửa lại được. Sau đó, bạn có thể di chuột qua các dấu này và xem chính xác điều gì sai và có thể khắc phục ngay lập tức

Chủ đề màu¶

Hiện tại mình đang dùng Theme Night Owl. Một chủ đề tối tuyệt đẹp cho những con cú đêm ngoài kia. Được tinh chỉnh cho những người trong chúng ta, những người thích viết mã đến khuya. Các lựa chọn màu sắc đã cân nhắc những gì người mù màu và trong điều kiện ánh sáng yếu có thể tiếp cận được. Các quyết định cũng dựa trên sự tương phản có ý nghĩa đối với khả năng đọc hiểu và để có được hiệu ứng lóa mắt tối ưu.

Mình rất thích theme này nhưng lâu lâu cũng chuyển qua cho đa dạng

Phần kết luận¶

Có nhiều Tiện ích mở rộng tuyệt vời hơn, như hỗ trợ git và thậm chí cả các tiện ích mở rộng đặc biệt cho các khung như Flask hoặc Django. Thiết lập của tôi rất tối thiểu, nhưng nó hoạt động với tôi. Hãy cho tôi biết bạn đang sử dụng Tiện ích mở rộng nào trong phần bình luận bên dưới video 😊

Mục đích của một chuỗi tài liệu Python là gì?

Làm cách nào để tạo chuỗi tài liệu trong Python?

Ví dụ về chuỗi tài liệu Python là gì?

Khi nào bạn nên sử dụng một chuỗi tài liệu?