2013-09-06 45 views
55

PyCharm 2.7 (hoặc PyCharm 3) có hỗ trợ cho các chuỗi doctest và doctest tùy chỉnh không? Nếu vậy, làm cách nào để viết về loại tiện ích tùy chỉnh cụ thể này?Tuỳ chỉnh PyCharm docstring stubs (ví dụ: đối với các định dạng google docstring hoặc numpydoc)

Dự án hiện tại của tôi đã được chuẩn hóa bằng cách sử dụng Hướng dẫn kiểu Google Python (http://google-styleguide.googlecode.com/svn/trunk/pyguide.html). Tôi thích hỗ trợ docstring của PyCharm, nhưng chỉ có hai định dạng được hỗ trợ ngay bây giờ là epytext và reStructureText. Tôi muốn, và sẵn sàng để viết bản thân mình, một plugin PyCharm tạo ra một cuống 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/). Đặc biệt quan trọng ở đây là kết hợp các khả năng suy luận kiểu mà PyCharm có với hai loại tài liệu khác.

+4

Hình như http: // youtrack.jetbrains.com/issue/PY-9795. – CrazyCoder

Trả lời

68

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

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

Làm thế nào để thay đổi Format docstring:

File -> Settings -> Tools -> Công cụ Python Integrated

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

Đồng bằng, Epytext, reStructuredText, NumPy, Google

Như được chỉ ra bởi jstol: đối với người dùng Mac, đây là dưới

PyCharm -> Preferences -> Tools -> Python Integrated Tools.

+6

Đối với người dùng máy Mac, điều này là dưới PyCharm -> Preferences -> Tools -> Python Integrated Tools. – jstol

+2

Bất kỳ ý tưởng làm thế nào để thực hiện lựa chọn này dính khi tôi bắt đầu một dự án mới? Đó là một nỗi đau để phải săn lùng thiết lập này mỗi lần. – superbeck

+1

Cân nhắc cập nhật câu trả lời này để bao gồm thông tin trong nhận xét từ jstol –

4

Như CrazyCoder đề cập, một số ticket. Ngay bây giờ, bạn chỉ có thể sử dụng EpyTypereStructuredText.

1

Chỉ cần được làm @Nras trả lời rõ ràng, tính đến PyCharm 5.0:

File> Cài đặt> Tools> Công cụ Python Integrated> docstrings> Google