Вопросы с тегом «documentation»

Недавно я начал изучать Python , но не смог найти, как реализовать многострочные комментарии. Большинство языков имеют символы блочных комментариев, такие как /* */ Я пробовал это в Python, но он выдает ошибку, так что это, вероятно, не правильный путь. Есть ли в Python функция многострочных комментариев?

1157 python  comments  documentation 

В Objective C я могу использовать #pragma markдля маркировки разделов моего кода в навигаторе символов. Так как это команда препроцессора C, она не доступна в Swift. Есть ли замена для этого в Swift, или я должен использовать уродливые комментарии?

936 swift  documentation 

Закрыто . Этот вопрос основан на мнении . В настоящее время он не принимает ответы. Хотите улучшить этот вопрос? Обновите вопрос, чтобы ответить на него фактами и цитатами, отредактировав этот пост . Закрыто 2 года назад . Я видел несколько разных стилей написания строк документации на Python, есть ли официальный …

889 python  coding-style  documentation  docstring 

В настоящее время этот вопрос не очень подходит для нашего формата вопросов и ответов. Мы ожидаем, что ответы будут подтверждены фактами, ссылками или опытом, но этот вопрос, скорее всего, вызовет дебаты, споры, опрос или расширенное обсуждение. Если вы считаете, что этот вопрос можно улучшить и, возможно, вновь открыть, обратитесь за …

258 documentation  comments 

Закрыто. Этот вопрос не соответствует рекомендациям по переполнению стека . В настоящее время он не принимает ответы. Хотите улучшить этот вопрос? Обновите вопрос, чтобы он соответствовал теме переполнения стека. Закрыто 2 года назад . Улучшить этот вопрос Одной из новых функций Xcode 5 является возможность документировать свой собственный код со …

186 objective-c  documentation  comments  doxygen  xcode5 

Таким образом, я полностью понимаю, как использовать resample , но документация не делает хорошую работу, объясняя варианты. Таким образом, большинство параметров в resampleфункции довольно просты за исключением этих двух: правило: строка смещения или объект, представляющий целевое преобразование how: строка, метод понижения или повторной выборки, по умолчанию «среднее» Поэтому, просмотрев столько …

184 python  documentation  pandas 

Закрыто . Этот вопрос основан на мнении . В настоящее время он не принимает ответы. Хотите улучшить этот вопрос? Обновите вопрос, чтобы ответить на него фактами и цитатами, отредактировав этот пост . Закрыто 2 года назад . Улучшить этот вопрос Итак, я прочитал как PEP 8, так и PEP 257 …

168 python  documentation  module 

Закрыто . Этот вопрос основан на мнении . В настоящее время он не принимает ответы. Хотите улучшить этот вопрос? Обновите вопрос, чтобы ответить на него фактами и цитатами, отредактировав этот пост . Закрыто 2 года назад . Улучшить этот вопрос В настоящее время я начинаю с Python и имею большой …

162 python  documentation  javadoc  docstring 

В настоящее время я пишу небольшой фреймворк, который будет использоваться другими разработчиками внутри компании. Я хочу предоставить хорошую информацию Intellisense, но не уверен, как документировать возникшие исключения. В следующем примере: public void MyMethod1() { MyMethod2(); // also may throw InvalidOperationException } public void MyMethod2() { System.IO.File.Open(somepath...); // this may throw …

141 c#  .net  documentation  intellisense 

Как документировать методы с параметрами, используя строки документации Python? РЕДАКТИРОВАТЬ: 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 ... …

139 python  documentation  documentation-generation 

Закрыто. Этот вопрос не соответствует рекомендациям по переполнению стека . В настоящее время он не принимает ответы. Хотите улучшить этот вопрос? Обновите вопрос, чтобы он соответствовал теме Stack Overflow. Закрыт 12 месяцев назад . Уточните этот вопрос Я пытаюсь найти документацию по использованию API FFmpeg C. Похоже, что доступна только …

120 c  api  documentation  ffmpeg 

Закрыто . Этот вопрос основан на мнении . В настоящее время он не принимает ответы. Хотите улучшить этот вопрос? Обновите вопрос, чтобы на него можно было ответить фактами и цитатами, отредактировав этот пост . Закрыт 6 лет назад . Уточните этот вопрос TeX / LaTeX великолепен, я использую его по-разному. …

118 documentation  latex  tex 

Закрыто . Этот вопрос основан на мнении . В настоящее время он не принимает ответы. Хотите улучшить этот вопрос? Обновите вопрос, чтобы на него можно было ответить с помощью фактов и цитат, отредактировав этот пост . Закрыт 2 года назад . Уточните этот вопрос Я пишу облегченный класс, атрибуты которого …

115 python  class  documentation  docstring  class-attributes 

В JSDoc лучшая документация, которую я могу найти, показывает, как использовать следующее, если у вас есть массив определенного типа (например, массив строк), например: /** * @param {Array.<string>} myStrings All my awesome strings */ function blah(myStrings){ //stuff here... } Как бы вы заменили приведенные ниже вопросительные знаки указанием массива объектов? /** …

105 javascript  documentation  jsdoc 

Существует ли стандарт интерпретации синтаксиса интерфейсов функций в документации API, и если да, то как он определяется? Вот пример того, как изменить цвет элемента в руководстве по написанию сценариев JavaScript для Photoshop для функции "fillColor": fillPath ([fillColor] [, mode] [, opacity] [, preserveTransparency] [, feather] [, wholePath] [, antiAlias]) Что …

105 api  documentation