Какие знаешь форматы написания docstring

В Python распространены несколько форматов docstring, каждый со своим синтаксисом и особенностями:

1. Google Style
   Чистый и читаемый формат с разделами Args, Returns, Examples.

   python

   Копировать

   def func(arg1, arg2):
       """Краткое описание.
   
       Args:
           arg1 (int): Описание аргумента.
           arg2 (str): Описание аргумента.
   
       Returns:
           bool: Описание возвращаемого значения.
       """

2. NumPy/SciPy Style
   Подробный формат с разделами Parameters, Returns, Examples.

   python

   Копировать

   def func(arg1, arg2):
       """Краткое описание.
   

   Parameters
   ----------
   arg1 : int
       Описание аргумента.
   arg2 : str
       Описание аргумента.

   Returns
   -------
   bool
       Описание возвращаемого значения.
   """

3. **reStructuredText (reST)**  
Используется в официальной документации Python.  
```python
def func(arg1, arg2):
    """Краткое описание.

    :param arg1: Описание аргумента (int).
    :param arg2: Описание аргумента (str).
    :return: Описание возвращаемого значения (bool).
    """

4. Epytext
   Напоминает Javadoc, но менее популярен.
   python

   Копировать

   def func(arg1, arg2):
       """Краткое описание.
   
       @param arg1: Описание аргумента (int).
       @param arg2: Описание аргумента (str).
       @return: Описание возвращаемого значения (bool).
       """

Для автоматической генерации документации чаще используют Google Style или NumPy Style. Выбор зависит от предпочтений команды и инструментов (Sphinx, pydoc, etc).