ЭТА ТЭГ ПРЕДНАЗНАЧЕН ТОЛЬКО ДЛЯ ГЕНЕРАТОРОВ ДОКУМЕНТОВ. Включите также язык и / или тег SDE. НЕ ИСПОЛЬЗУЙТЕ, чтобы запрашивать ссылки на документацию или инструменты, или чтобы критиковать документацию поставщика.
Недавно я начал изучать Python , но не смог найти, как реализовать многострочные комментарии. Большинство языков имеют символы блочных комментариев, такие как /* */ Я пробовал это в Python, но он выдает ошибку, так что это, вероятно, не правильный путь. Есть ли в Python функция многострочных...
В Objective C я могу использовать #pragma markдля маркировки разделов моего кода в навигаторе символов. Так как это команда препроцессора C, она не доступна в Swift. Есть ли замена для этого в Swift, или я должен использовать уродливые...
Закрыто . Этот вопрос основан на мнении . В настоящее время он не принимает ответы. Хотите улучшить этот вопрос? Обновите вопрос, чтобы ответить на него фактами и цитатами, отредактировав этот пост . Закрыто 2 года назад . Я видел несколько разных стилей написания строк документации на Python,...
В настоящее время этот вопрос не очень подходит для нашего формата вопросов и ответов. Мы ожидаем, что ответы будут подтверждены фактами, ссылками или опытом, но этот вопрос, скорее всего, вызовет дебаты, споры, опрос или расширенное обсуждение. Если вы считаете, что этот вопрос можно улучшить и,...
При написании XML-документации вы можете использовать <see cref="something">something</see>, что, конечно, работает. Но как вы ссылаетесь на класс или метод с универсальными типами? public class FancyClass<T> { public string FancyMethod<K>(T value) { return "something...
Это должно быть намного проще ... Я хочу добавить «кодированный» разрыв строки в документацию XML в моем коде /// <summary> /// Get a human-readable variant of the SQL WHERE statement of the search element. <br/> /// Rather than return SQL, this method returns a string with...
Закрыто. Этот вопрос не соответствует рекомендациям по переполнению стека . В настоящее время он не принимает ответы. Хотите улучшить этот вопрос? Обновите вопрос, чтобы он соответствовал теме переполнения стека. Закрыто 2 года назад . Улучшить этот вопрос Одной из новых функций Xcode 5 является...
Таким образом, я полностью понимаю, как использовать resample , но документация не делает хорошую работу, объясняя варианты. Таким образом, большинство параметров в resampleфункции довольно просты за исключением этих двух: правило: строка смещения или объект, представляющий целевое преобразование...
Я знаю, что это не самая насущная проблема, но я только что понял, что могу поставить блок комментариев Javadoc до или после аннотации. Что бы мы хотели принять в качестве стандарта кодирования? /** * This is a javadoc comment before the annotation */ @Component public class MyClass { @Autowired...
Закрыто . Этот вопрос основан на мнении . В настоящее время он не принимает ответы. Хотите улучшить этот вопрос? Обновите вопрос, чтобы ответить на него фактами и цитатами, отредактировав этот пост . Закрыто 2 года назад . Улучшить этот вопрос Итак, я прочитал как PEP 8, так и PEP 257 , и я...
Закрыто . Этот вопрос основан на мнении . В настоящее время он не принимает ответы. Хотите улучшить этот вопрос? Обновите вопрос, чтобы ответить на него фактами и цитатами, отредактировав этот пост . Закрыто 2 года назад . Улучшить этот вопрос В настоящее время я начинаю с Python и имею большой...
Как я могу сообщить JSDoc о структуре возвращаемого объекта. Я нашел @return {{field1: type, field2: type, ...}} descriptionсинтаксис и попробовал: /** * Returns a coordinate from a given mouse or touch event * @param {TouchEvent|MouseEvent|jQuery.Event} e * A valid mouse or touch event or a...
В настоящее время я пишу небольшой фреймворк, который будет использоваться другими разработчиками внутри компании. Я хочу предоставить хорошую информацию Intellisense, но не уверен, как документировать возникшие исключения. В следующем примере: public void MyMethod1() { MyMethod2(); // also may...
Как документировать методы с параметрами, используя строки документации 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...
Закрыто. Этот вопрос не соответствует рекомендациям по переполнению стека . В настоящее время он не принимает ответы. Хотите улучшить этот вопрос? Обновите вопрос, чтобы он соответствовал теме Stack Overflow. Закрыт 12 месяцев назад . Уточните этот вопрос Я пытаюсь найти документацию по...
Закрыто . Этот вопрос основан на мнении . В настоящее время он не принимает ответы. Хотите улучшить этот вопрос? Обновите вопрос, чтобы на него можно было ответить фактами и цитатами, отредактировав этот пост . Закрыт 6 лет назад . Уточните этот вопрос TeX / LaTeX великолепен, я использую его...
Закрыто . Этот вопрос основан на мнении . В настоящее время он не принимает ответы. Хотите улучшить этот вопрос? Обновите вопрос, чтобы на него можно было ответить с помощью фактов и цитат, отредактировав этот пост . Закрыт 2 года назад . Уточните этот вопрос Я пишу облегченный класс, атрибуты...
Существует ли стандарт интерпретации синтаксиса интерфейсов функций в документации API, и если да, то как он определяется? Вот пример того, как изменить цвет элемента в руководстве по написанию сценариев JavaScript для Photoshop для функции "fillColor": fillPath ([fillColor] [, mode] [, opacity]...
В JSDoc лучшая документация, которую я могу найти, показывает, как использовать следующее, если у вас есть массив определенного типа (например, массив строк), например: /** * @param {Array.<string>} myStrings All my awesome strings */ function blah(myStrings){ //stuff here... } Как бы вы...
Документация для обеспечения интеграции XmlDoc в ваши Api проектов Web появляется только рукоятки ситуаций , когда все ваши типов API являются частью вашего WebAPI проекта. В частности, обсуждается, как перенаправить XML-документацию App_Data/XmlDocument.xmlи раскомментировать строку в вашей...