documentation- все статьи тега


Как документировать проект базы данных в visualstudio

Основываясь на своих знаниях о документации на c# с помощью Visual studio, я активировал xml-файл в Properties- > SQLCLR-Build- > XML-Documentationfile. Теперь xml-файл создан, но я не могу понять, какие теги разрешены и как начать документацию В c# я бы сделал /// <summary> /// does some stuff /// </summary> public .... Поэтому я сделал то же самое в sql --- <summary> --- does some stuff --- </summary> CREATE PROCEDURE .... Но созданный xml не отражает м ...

Что такое самодокументированный код и может ли он заменить хорошо документированный код? [закрытый]

У меня есть коллега, который утверждает, что его код не нуждается в комментариях, это "нагляден." Я просмотрел его код, и хотя он яснее, чем код, который я видел у других, я все еще не согласен с тем, что самодокументированный код является таким же полным и полезным, как и комментируемый и документированный код. помогите мне понять его точки зрения. что такое самостоятельное документирование кода может ли он действительно заменить хорошо прокомментированный и документированный код есть ли си ...

Использование javadoc для документации Python [закрыто]

в настоящее время я начинаю с Python, и у меня есть сильный фон PHP, и в PHP я взял привычку использовать javadoc в качестве шаблона документация. мне было интересно, если javadoc место docstring документация на Python. Является ли что-то подобное слишком сложным, чтобы вписаться в мышление Python, или я должен стараться быть как можно более кратким? """ replaces template place holder with values @param string timestamp formatted date to display @param string priority priority number ...

документация по api pinterest [закрыто]

Обновление Aug 2015: Pinterest предоставляет его здесь сейчас https://dev.pinterest.com/ есть ли официальная или неофициальная документация по V2 Pinterest API? вещи, которые я знаю: JSON api находится в версии 2. https://api.pinterest.com/v2 дает вам ответ json люди программируют против него, потому что есть мобильное приложение и бета Дев вопрос аутентификации Pintrest на SO PHP обертка для v1 с обновлениями для v2 на Github от Kellan С методами: upload, pin, repin, boards, activity, po ...

Как документировать метод с параметром(АМИ)? [закрытый]

как документировать методы с параметрами, используя строки документации Python? EDIT: PEP 257 приводит такой пример: def complex(real=0.0, imag=0.0): """Form a complex number. Keyword arguments: real -- the real part (default 0.0) imag -- the imaginary part (default 0.0) """ if imag == 0.0 and real == 0.0: return complex_zero ... это соглашение используется большинством разработчиков Python ? Keyword arguments: <parameter name> -- Definition (default va ...

Андроид оффлайн документация и примеры кода [закрыт]

Я не могу найти автономные документы для android. Может ли кто-нибудь предоставить ссылку? ...

Как документировать код Python с помощью doxygen [закрыто]

Мне нравится doxygen для создания документации C или PHP кода. У меня есть предстоящий проект Python, и я думаю, что помню, что Python не имеет /* .. */ комментарии, а также будет иметь собственную документацию объекта, который, кажется, быть подходящие для Python путь к документу. поскольку я знаком с doxygen, как я могу использовать его для создания моей документации Python? Есть ли что-то особенное, что мне нужно знать? ...

Использование Javascript внутри PDF [закрыто]

где я могу найти документацию по запуску Javascript внутри PDF? Я никогда не добавлял действие javascript внутри pdf. Тем не менее, я сделал довольно много веб-разработки с использованием javascript. У меня есть несколько вопросов к тому, кто имеет какое-либо знакомство с javascript внутри PDF. NitroPDF и Adobe Acrobat определенно поддерживают javascript в PDF-файлах. есть ли стандарт на различные объекты, которые существуют и функции для управления pdf с помощью javascript? все, что я наше ...

Синтаксис для документирования структуры JSON

поэтому я пытаюсь документировать формат json, возвращаемый api, против которого я пишу, и я хотел бы знать, есть ли какой-либо популярный формат для документации структуры json. примечание Я не пытаюсь проверить или проверить что-либо, я просто использую это для документации. Также было бы неплохо добавить комментарии к непостоянным(элементы всегда возвращаются с одним и тем же значением). это не совсем продуманная схема я сейчас использование: Plain names refer to identifiers or types. Som ...

Как правильно документировать параметр * * kwargs? [закрытый]

Я использую сфинкс и плагин autodoc для создания документации API для моих модулей Python. Хотя я вижу, как красиво документировать определенные параметры, я не могу найти пример того, как документировать a . у кого-нибудь есть хороший пример четкого способа документировать их? ...

Как создать несколько уровней отступа в Javadoc?

предположим, что в рамках документирования вашего кода (Javadoc) вы хотите указать, что отношения между элементами используют глубокий отступ. Как я могу создать вложенный список в виде: какой-то элемент какой-то другой элемент еще какой-то элемент ...