Описание тега inheritdoc

1 ответ

Как выполнить наследование комментариев Javadoc от JDK с помощью задачи Gradle Javadoc?

Я хочу, чтобы мой Javadoc унаследовал комментарии от стандартных классов JDK. Для этого мне нужно добавить источники JDK в -sourcepath вариант Javadoc. Чтобы не создавать документацию для самих классов JDK, я бы указывал пакеты через -packagenames и…
12 авг '14 в 13:49
2 ответа

Почему Javadoc не заставляет мои подклассы наследовать документацию от классов Java?

Я искал ответ в течение нескольких месяцев, и я попробовал несколько вещей, включая разархивирование папки Compressed src.zip и использование ее в качестве параметра для Javadoc (например: javadoc -sourcepath src com.example.test) Это Javadoc по умо…
23 май '11 в 19:46
1 ответ

Задача Javadoc через Ant с {@inheritDoc} из классов J2SE

Я создаю документацию для проекта, используя задачу Ant. В некоторых местах я хотел унаследовать документацию от стандартных классов, поэтому я использовал {@inheritDoc} что позволило мне увидеть Javadoc в Eclipse, но он не будет отображаться в файл…
30 мар '10 в 15:55
3 ответа

Метод переопределения документации Java не наследует

Метод, который переопределяет другой метод, не наследует документацию метода, который он переопределяет. Есть ли способ явно сказать ему, чтобы унаследовать документацию? /** * {@inheritDoc} * * This implementation uses a dynamic programming approac…
04 июл '09 в 03:13
1 ответ

Фильтровать содержимое унаследованных комментариев к параметрам

У меня есть комментарии, как это: /// <summary>some summary</summary> /// <param name="a"> /// <para id="0">Comment 0</para> /// <para id="1">Comment 1</para> /// <para id="2">Comment 2</para> //…
02 мар '12 в 10:21
2 ответа

Можно ли наследовать документацию от конкретных параметров?

Visual Studio 2017, ReSharper 2017, проект C# Я пытаюсь наследовать документацию параметра метода с помощью select атрибут, но он не работает, как ожидалось. Согласно этой статье ( http://tunnelvisionlabs.github.io/SHFB/docs-master/SandcastleBuilder…
3 ответа

Класс тегов Javadoc {@inheritDoc}

Я хотел бы использовать {@inheritDoc} класс для наследования методов от моего абстрактного класса. В документации по абстрактному классу я ссылаюсь на абстрактный класс по имени. Как я могу пометить это так, чтобы, когда подкласс наследовал документ…
29 янв '10 в 20:39
1 ответ

Stylecop не понимает <наследник />

Я пытаюсь использовать Stylecop 4.7.31 У меня есть проект, где объявлен интерфейс: public interface IRmlManager { /// &lt;summary&gt; /// Adds the notification. /// &lt;/summary&gt; /// &lt;param name="notificationData"&gt;The notification data.&lt;…
14 июн '12 в 20:07
1 ответ

{@inheritdoc} заменен на @ERROR

Я недавно установил Eclipse для PHP на новый ноутбук и извлек пакеты из TYPO3.Flow, но всякий раз, когда я использую опцию "форматировать этот файл" в Eclipse, он заменяет каждый экземпляр {@inheritdoc} в комментариях к комментариям над свойствами /…
10 фев '15 в 10:19
1 ответ

{@inheritDoc} не наследует Javadoc суперкласса в Eclipse

Когда я использую {@inheritDoc} в Eclipse, комментарии javadoc суперкласса не появляются в javadoc моего класса. У меня есть следующий кусок кода: import javax.swing.table.AbstractTableModel; public class TestTableModel extends AbstractTableModel { …
07 авг '09 в 05:41
2 ответа

Правильный синтаксис дляоризит в phpDocumentor

Какой правильный синтаксис для @inheritDoc в phpDocumentor, если я просто хочу наследовать всю документацию от родительского? Может быть, более одного синтаксиса является правильным? @inheritDoc {@inheritDoc} @inheritdoc {@inheritdoc} Документация д…
24 окт '14 в 15:05
0 ответов

Как я могу получить исходное описание, на которое тег {@inheritdoc} ссылается в исходном коде?

Я использую JavaParaserдля синтаксического анализа JavaDoc из исходного кода. А теперь мне нужно получить комментарии к методу, хотя их много.{@inheritDoc}которому не хватает читабельности. Итак, я хочу получить исходное описание. Есть ли какой-нибу…
20 дек '19 в 12:08
0 ответов

Не удается использовать inheritdoc с Cref для добавления комментариев к параметрам функции

У меня проблема при попытке использовать inheritdoc с cref для добавления комментариев к параметрам функции. В частности, у меня есть класс со свойством и конструктором. Я хочу, чтобы параметр моего конструктора унаследовал комментарий свойства, но …
14 апр '20 в 01:13
1 ответ

Автоматическое добавление /// &lt;inheritdoc/&gt; при реализации методов из интерфейса

Есть ли в Visual Studio 2019 или ReSharper способ автоматического добавления ///&lt;inheritdoc/&gt; при реализации отсутствующих членов из интерфейса / базового класса? Я довольно много проверял в Google, но ничего не нашел.
1 ответ

Могу ли я использовать &lt;inheritdoc cref&gt; для ссылки на сводку XML другой переменной?

Когда я пишу функции для своего проекта, а точнее, их комментарии к XML-документации, я часто повторяю комментарии для определенного параметра. Иногда это приводит к вводящей в заблуждение документации (как это обычно бывает при копировании...). Это…
06 авг '20 в 16:07
0 ответов

Есть ли неявный &lt;inheritdoc /&gt;?

В Visual Studio я заметил, что когда я нахожу метод, он действует так, как будто есть &lt;inheritdoc /&gt;, а когда его нет. Наглядный пример здесь Почему и откуда это? Из-за Visual Studio? Кроме того, как вы думаете, следует ли мне добавить &lt;inh…
25 окт '21 в 15:28
0 ответов

Как использовать {@inheritDoc} с классами, расширяющими java.util?

У меня есть класс HashSet, который реализует Deque: при создании методов я хотел бы просто использовать javadoc для связанных методов, которые он наследует/реализует. Однако, когда я запускаю его через javadoc, я получаю пустые описания . Для некото…
28 ноя '22 в 13:52
0 ответов

Как использовать `&lt;inheritdoc cref="..."&gt;`, если один из параметров имеет ключевое слово `in`?

У меня есть следующая функция: public int Get(ref X a, ref Y b, int c, in Z d = default) { ... } и перегрузка, которую я пытаюсь использовать&lt;inheritdoc&gt;от: /// &lt;summary&gt; /// ... /// &lt;inheritdoc cref="Get(ref X, ref Y, int, Z)"/&gt; /…
21 апр '23 в 07:04