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

100
Как я могу ссылаться на значение последнего статического поля в классе?

Как с помощью JavaDoc ссылаться на значение последнего статического поля в классе? Я хочу, чтобы ???в этом примере заменили значение поля STATIC_FIELD. /** * This is a simple class with only one static field with the value ???. */ public class Simple { /** * We can reference the value with...

98
Способы синхронизации интерфейса и комментариев реализации в C # [закрыто]

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

98
Где разместить блоки комментариев doxygen для внутренней библиотеки - в H или в файлах CPP? [закрыто]

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

97
Наследование строк документации в наследовании классов Python

Я пытаюсь наследовать классы в Python. Я бы хотел, чтобы у каждого класса и унаследованного класса были хорошие строки документации. Поэтому я думаю, что для унаследованного класса я бы хотел: наследовать строку документации базового класса возможно, добавить соответствующую дополнительную...

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

Закрыто. Этот вопрос не соответствует рекомендациям по переполнению стека . В настоящее время он не принимает ответы. Хотите улучшить этот вопрос? Обновите вопрос, чтобы он соответствовал теме Stack Overflow. Закрыт 4 года назад . Уточните этот вопрос Обновление, август 2015: Pinterest...

96
Как задокументировать строковый тип в jsdoc с ограниченными возможными значениями

У меня есть функция, которая принимает один строковый параметр. Этот параметр может иметь только одно из нескольких определенных возможных значений. Как лучше всего задокументировать то же самое? Следует ли определять shapeType как enum, TypeDef или что-то еще? Shape.prototype.create = function...

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

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

91
Используете roxygen2 и doxygen в одном пакете? [закрыто]

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

90
Сравните и сопоставьте облегченные языки разметки [закрыто]

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

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

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

84
Как указать разрешение и тип отклонения обещания в JSDoc?

У меня есть код, который возвращает объект обещания, например, используя библиотеку Q для NodeJS. var Q = require('q'); /** * @returns ??? */ function task(err) { return err? Q.reject(new Error('Some error')) : Q.resolve('Some result'); } Как задокументировать такое возвращаемое значение с помощью...

83
Офлайн-документация по Android и примеры кодов [закрыто]

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

80
Node.js запрашивает документацию по объекту? [закрыто]

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