topwebmaster
@topwebmaster
Веб-программист, django, laravel, php, python

Что значит такой синтаксис многострочного комментария в python?

def get_nameservers(self, domain):
        """Get Nameservers for the given domain.

        ::
            >>> from dynadotpy.client import Dynadot
            >>> dyn = Dynadot(api_key="<key>")
            >>> result = dyn.get_nameservers(domain="example.com")
            {"result": u"success", "ns0": u"ns1.example.com"...

        :param: String of the domain.
        :return: `dict` of the response from Dynadot's API.
        """
  • Вопрос задан
  • 322 просмотра
Решения вопроса 1
@javedimka
Хочу сока
Это значит, что он написан для Sphinx(или для Docutils, например) - генератора HTML(и не только) документации, сам синтаксис - reStructuredText
Более подробно:
docs.python-guide.org/en/latest/writing/documentation
Конкретные примеры синтаксиса и то как они будут обработаны генератором:
docutils.sourceforge.net/docs/user/rst/quickref.html
Ответ написан
Пригласить эксперта
Ответы на вопрос 1
Де-факто это способ написания многострочного комментария.В питоне это три апострофа:
'''
комментарий
'''
либо через двойные кавычки:
"""
коментарий
"""

а к примеру в том же C это бэкслеш+звёздочка:
/*
комментарий
*/
Ответ написан
Ваш ответ на вопрос

Войдите, чтобы написать ответ

Войти через центр авторизации
Похожие вопросы