Làm cách nào tôi có thể tạo đoạn văn liên quan đến các quy tắc định dạng của tài liệu Python?

Nếu tôi nhấn M-qtrong một chuỗi doc như thế này, thì dòng bị đứt trong chuỗi doc bị rối:

def foo(word):
  """
  This is a function that does something.
  @param word: str, input.
  @returns: True
  """

trở thành cái này

def foo(word):
  """This is a function that does something. @param word:
  str, input. @returns: True
  """

python-doc chuỗi là một gói ghi đè lên đoạn văn để nó tương thích với các tài liệu Python. Nó hoạt động cho cả định dạng sphinx-doc và reSturationuredtext. Nó cũng cung cấp đánh dấu cú pháp và tôi tin rằng sẽ làm nổi bật đánh dấu trong các tài liệu của bạn.

Đây có thể là một nơi tốt để bắt đầu. Tôi đã không thử bản thân mình, nhưng nếu bạn có một định dạng chuỗi không bao gồm, thì có thể mở rộng gói. Đối với trường hợp sử dụng của bạn, tôi tưởng tượng nó sẽ là một trường hợp chỉnh sửa các biểu thức chính quy phát hiện các biến. Tuy nhiên, có thể khó hơn để nó hoạt động cho các tài liệu kiểu Google, tuy nhiên.