String docstring PyCharm tùy chỉnh (tức là cho các định dạng google docstring hoặc numpydoc)


75

PyCharm 2.7 (hoặc PyCharm 3) có hỗ trợ cho tài liệu tùy chỉnh và sơ khai tài liệu không? Nếu vậy, làm cách nào để viết loại tiện ích mở rộng tùy chỉnh cụ thể này?

Dự án hiện tại của tôi đã chuẩn hóa về việc sử dụng Hướng dẫn kiểu Python của Google ( http://google-styleguide.googlecode.com/svn/trunk/pyguide.html ). Tôi thích hỗ trợ docstring của PyCharm, nhưng hiện tại chỉ có hai định dạng được hỗ trợ là epytext và reStructureText. Tôi muốn và sẵn sàng tự viết một plugin PyCharm tạo ra một bản gốc nhận xét tài liệu được định dạng theo kiểu Google hoặc Numpydoc ( https://pypi.python.org/pypi/sphinxcontrib-napoleon/ ). Điều đặc biệt quan trọng ở đây là kết hợp khả năng suy luận kiểu mà PyCharm có với hai kiểu tài liệu khác.


Câu trả lời:


102

Với PyCharm 5.0, cuối cùng, chúng tôi phải chọn các mẫu Google và NumPy Style Python Docstrings .

Nó cũng được đề cập trong phần whatsnew cho PyCharm 5.0.

Cách thay đổi Định dạng Docstring:

Tệp -> Cài đặt -> Công cụ -> Công cụ tích hợp Python

Ở đó, bạn có thể chọn từ các định dạng Docstrings có sẵn:

Plain, Epytext, reStructuredText, NumPy, Google

Như đã chỉ ra bởi jstol: đối với người dùng Mac, điều này là

PyCharm -> Tùy chọn -> Công cụ -> Công cụ tích hợp Python.


8
Đối với người dùng Mac, điều này nằm trong PyCharm -> Tùy chọn -> Công cụ -> Công cụ tích hợp Python.
jstol

3
Bất kỳ ý tưởng làm thế nào để làm cho lựa chọn này phù hợp khi tôi bắt đầu một dự án mới? Thật là khó khăn khi phải truy tìm bối cảnh này mỗi lần.
tuyệt vời

1
Cân nhắc cập nhật câu trả lời này để bao gồm thông tin trong bình luận từ jstol
Kane C


1

Chỉ cần đặt câu trả lời @Nras rõ ràng, kể từ PyCharm 5.0 :

Tệp> Cài đặt> Công cụ> Công cụ tích hợp Python> Docstrings> Google

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.