я продолжаю видеть, что есть строки документации линий, которые читаются как это:В Python Docstrings, что есть `: obj:` do?
param : :obj: str
Я не могу найти ссылку на то, что :obj: означает или делает. Похоже, что это означало бы на str объект, но я также вижу
param : int
, который, кажется, не вяжется.
Спасибо.
Это не встроенная функциональность Python. Автор кода, который вы ищете, использует внешний инструмент для автоматической генерации документации. Он выглядит как синтаксис Sphinx, но я не уверен.
Я предполагаю, что вы находите их на докстерах для функций и методов. Они идентифицируют типы аргументов для генератора автоматической документации, чтобы правильно документировать подпись функции/метода.
Одно замечание о таких документах как о том, что для их форматирования нет реального «стандарта». Sphinx использует синтаксис RST и Google имеет руководство по стилю Python с другим синтаксисом. Но вы можете поместить все, что полезно для вас и ваших пользователей в docstring ... они сделаны первыми для людей, и мы только применяем стандарты для них, чтобы помочь создать красивую документацию. –
Синтаксис, связанный с Sphinx, для вставки ссылки на объект `str в стандартной документации Python. См. Также Python Documentation (:obj:`str`) vs (str).
Можете ли вы скопировать или связать некоторые примеры в контексте? –