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

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

100 java  documentation  javadoc 

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

98 c#  documentation  xml-documentation 

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

98 documentation  comments  doxygen 

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

97 python  inheritance  documentation 

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

96 json  api  mobile  documentation  pinterest 

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

94 python  documentation  python-sphinx  doxygen  docstring 

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

91 c  r  documentation  doxygen  roxygen2 

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

90 documentation  markdown  markup  restructuredtext  textile 

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

88 documentation  javadoc  indentation  nested-lists 

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

84 javascript  node.js  documentation  jsdoc  promise 

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

83 android  documentation  offline 

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

80 node.js  documentation  request