В C / C ++ вы можете заставить doxygen распознавать, что комментарий относится к тексту, предшествующему ему в строке.Любой из них:
int my_variable; /*!< This is my variable */
int my_variable; /**< This is my variable */
int my_variable; //!< This is my variable
int my_variable; ///< This is my variable
добавляет строку к документации для my_variable.Попытка эквивалента в Python, похоже, не работает.Это работает:
## This is my variable
my_variable = None
Это:
my_variable = None ## This is my variable
my_other_variable = None
присоединяет документацию к my_other_variable, как и следовало ожидать, но оба из них:
my_variable = None ##< This is my variable
my_variable = None #!< This is my variable
Кажется, просто отказаться от документации.Есть ли способ сделать эквивалент //!< в Python?