Как пишутся комментарии к функции

@c4_d · Регистрация: 17.11.2013

Студворк — интернет-сервис помощи студентам

Добрый день!
Встала задача написать немного кода на питоне и передать его.
код я написал, но хотелось бы написать Коментарии к функциям.
В С# они выглядят вот так

C#
1
2
3
4
/// <summary>DoWork is a method in the TestClass class.
    /// <para>Here's how you could make a second paragraph in a description. <see cref="System.Console.WriteLine(System.String)"/> for information about output statements.</para>
    /// <seealso cref="TestClass.Main"/>
    /// </summary>

Как сделать что-то подобное на пайтоне? Заранее спасибо.

Добавлено через 2 минуты
работаю в Eclipse если что

@alex925 · 27.08.2014, 16:51

Комментарии в python пишутся после решётки (#). Есть ещё также многострочные комментарии (они же строки документации, за подробностями об этом читайте в сети), они обознаются тремя кавычками ("""текст комментария""").

Вообще если честно странный вопрос.
Такие моменты гуглся с пол запроса, а вы на форуме спрашиваете.

Сообщение от c4_d

работаю в Eclipse если что

Причем тут ide то?

@c4_d · 27.08.2014, 16:59 **[ТС]**

tsar925,
ну про # я знаю, про 3 кавычки тоже.
Есть как бы подсказки для разработчика в при нажатии (контрл+пробел).
Я вот о чем спрашиваю.
Я бы хотел все комментарии написать в этих подсказках, для удобаства и простоты. Как то так.

Добавлено через 54 секунды
А про Eclipce я написал, потому, что разные IDE и может оформление подобых подсказок разное.

@alex925 · 27.08.2014, 17:02

Вы говорите об функции автодополнения и это совсем другая история, не имеющая никакого отношения к python.
Это уже настройки ide или плагина в ide который реализует автодополнение.

@c4_d · 27.08.2014, 17:12 **[ТС]**

@alex925 · 27.08.2014, 17:16

Ну и? Вы показали мне авто дополнение Eclipse и что?

Единственное что прописывается в коде программы, это строки документации (текст между 3 кавычек), которые потом можно читать с помощью функции help и ещё какой-то утилиты из стандартной поставки интерпретатора для windows.

@easybudda · 30.08.2014, 04:46

c4_d, если включать в тело функции документацию, она должна бы подсвечиваться при вызове функции. Вот из Komodo Edit скриншот

Новые блоги и статьи Все статьи Все блоги /
PhpStorm 2025.3: WSL Terminal всегда стартует в ~ and_y87 14.12.2025 PhpStorm 2025. 3: WSL Terminal всегда стартует в ~ (home), игнорируя директорию проекта Симптом: После обновления до PhpStorm 2025. 3 встроенный терминал WSL открывается в домашней директории. . .	Access VikBal 11.12.2025 Помогите пожалуйста !! Как объединить 2 одинаковые БД Access с разными данными.	Новый ноутбук volvo 07.12.2025 Всем привет. По скидке в "черную пятницу" взял себе новый ноутбук Lenovo ThinkBook 16 G7 на Амазоне: Ryzen 5 7533HS 64 Gb DDR5 1Tb NVMe 16" Full HD Display Win11 Pro	Музыка, написанная Искусственным Интеллектом volvo 04.12.2025 Всем привет. Некоторое время назад меня заинтересовало, что уже умеет ИИ в плане написания музыки для песен, и, собственно, исполнения этих самых песен. Стихов у нас много, уже вышли 4 книги, еще 3. . .	От async/await к виртуальным потокам в Python IndentationError 23.11.2025 Армин Ронахер поставил под сомнение async/ await. Создатель Flask заявляет: цветные функции - провал, виртуальные потоки - решение. Не threading-динозавры, а новое поколение лёгких потоков. Откат?. . .
Поиск "дружественных имён" СОМ портов Argus19 22.11.2025 Поиск "дружественных имён" СОМ портов На странице: https:/ / norseev. ru/ 2018/ 01/ 04/ comportlist_windows/ нашёл схожую тему. Там приведён код на С++, который показывает только имена СОМ портов, типа,. . .	Сколько Государство потратило денег на меня, обеспечивая инсулином. Programma_Boinc 20.11.2025 Сколько Государство потратило денег на меня, обеспечивая инсулином. Вот решила сделать интересный приблизительный подсчет, сколько государство потратило на меня денег на покупку инсулинов. . . .	Ломающие изменения в C#.NStar Alpha Etyuhibosecyu 20.11.2025 Уже можно не только тестировать, но и пользоваться C#. NStar - писать оконные приложения, содержащие надписи, кнопки, текстовые поля и даже изображения, например, моя игра "Три в ряд" написана на этом. . .	Мысли в слух kumehtar 18.11.2025 Кстати, совсем недавно имел разговор на тему медитаций с людьми. И обнаружил, что они вообще не понимают что такое медитация и зачем она нужна. Самые базовые вещи. Для них это - когда просто люди. . .	Создание Single Page Application на фреймах krapotkin 16.11.2025 Статья исключительно для начинающих. Подходы оригинальностью не блещут. В век Веб все очень привыкли к дизайну Single-Page-Application . Быстренько разберем подход "на фреймах". Мы делаем одну. . .

@c4_d 1 / 1 / 0 Регистрация: 17.11.2013 Сообщений: 22
	27.08.2014, 16:59 [ТС]
	tsar925, ну про # я знаю, про 3 кавычки тоже. Есть как бы подсказки для разработчика в при нажатии (контрл+пробел). Я вот о чем спрашиваю. Я бы хотел все комментарии написать в этих подсказках, для удобаства и простоты. Как то так. Добавлено через 54 секунды А про Eclipce я написал, потому, что разные IDE и может оформление подобых подсказок разное. 0

@alex925 2742 / 2341 / 620 Регистрация: 19.03.2012 Сообщений: 8,830
	27.08.2014, 17:02
	Вы говорите об функции автодополнения и это совсем другая история, не имеющая никакого отношения к python. Это уже настройки ide или плагина в ide который реализует автодополнение. 0

@c4_d 1 / 1 / 0 Регистрация: 17.11.2013 Сообщений: 22
	27.08.2014, 17:12 [ТС]
	0

@alex925 2742 / 2341 / 620 Регистрация: 19.03.2012 Сообщений: 8,830
	27.08.2014, 17:16
	Сообщение было отмечено c4_d как решение Решение Ну и? Вы показали мне авто дополнение Eclipse и что? Единственное что прописывается в коде программы, это строки документации (текст между 3 кавычек), которые потом можно читать с помощью функции help и ещё какой-то утилиты из стандартной поставки интерпретатора для windows. 1

@easybudda Модератор 12843 / 7592 / 1766 Регистрация: 25.07.2009 Сообщений: 13,973
	30.08.2014, 04:46
	c4_d, если включать в тело функции документацию, она должна бы подсвечиваться при вызове функции. Вот из Komodo Edit скриншот 1

Как пишутся комментарии к функции

Решение