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

864
Как ссылаться на метод в Javadoc?

Как я могу использовать @linkтег для ссылки на метод? Я хочу изменить: /** * Returns the Baz object owned by the Bar object owned by Foo owned by this. * A convenience method, equivalent to getFoo().getBar().getBaz() * @return baz */ public Baz fooBarBaz() чтобы: /** * Returns the Baz object owned...

632
Как работает «cat << EOF» в bash?

Мне нужно было написать скрипт для ввода многострочного ввода в программу ( psql). После небольшого поиска я нашел следующий синтаксис: cat << EOF | psql ---params BEGIN; `pg_dump ----something` update table .... statement ...; END; EOF Это правильно создает многострочную строку (от BEGIN;до...

417
Тип PHPDoc намекает на массив объектов?

Таким образом, в PHPDoc можно указывать @varвыше объявление переменной-члена, чтобы намекнуть на его тип. Тогда IDE, например. PHPEd будет знать, с каким типом объекта он работает, и сможет обеспечить понимание кода для этой переменной. <?php class Test { /** @var SomeObj */ private...

374
Как присвоить значение heredoc переменной в Bash?

У меня есть эта многострочная строка (цитаты включены): abc'asdf" $(dont-execute-this) foo"bar"'' Как бы я назначил его переменной, используя heredoc в Bash? Мне нужно сохранить переводы строк. Я не хочу избегать символов в строке, это будет раздражать...

316
Как описать «объектные» аргументы в jsdoc?

// My function does X and Y. // @params {object} parameters An object containing the parameters // @params {function} callback The callback function function(parameters, callback) { } Но как мне описать, как должен быть структурирован объект параметров? Например, это должно быть что-то вроде: {...

312
Maven не работает в Java 8, когда теги Javadoc неполны

Так как я использую Maven, я могу создавать и устанавливать в своих проектах локального репозитория, которые имеют неполные теги Javadoc (например, отсутствующий параметр). Однако, поскольку я перешел на Java 8 (1.8.0-ea-b90), Maven абсолютно строго относится к отсутствующим тегам документации и...

254
Как прикрепить javadoc или исходники к jar-файлам в папке libs?

В новой версии плагина ADT r17 для Eclipse добавлена ​​функция автоматической настройки зависимостей JAR. Любые файлы .jar в папке / libs будут добавлены в конфигурацию сборки. К сожалению, контейнер пути класса Android Dependencies не подлежит изменению. Как я могу прикрепить Javadoc и источники к...

238
Javadoc ссылка на метод в другом классе

В настоящее время я ссылаюсь на методы в других классах с этим синтаксисом Javadoc: @see {@link com.my.package.Class#method()} И в том, что я понимаю из документации, это правильный способ сделать это. Но теперь самое смешное или неприятное. Когда я генерирую этот javadoc, я в первую очередь...

230
Javadoc: package.html или package-info.java

При попытке создать комментарии на уровне пакета Javadoc, какой метод предпочтительнее? Чем ты занимаешься? package-info.java Pros Новее Cons Злоупотребление классом - классы для кода, а не только для комментариев package.html Pros Расширение HTML означает, что это не код Подсветка синтаксиса в IDE...

197
Выполнение многострочных операторов в однострочной командной строке?

Я использую Python -cдля выполнения однострочного цикла, то есть: $ python -c "for r in range(10): print 'rob'" Это отлично работает. Однако, если я импортирую модуль перед циклом for, я получаю синтаксическую ошибку: $ python -c "import sys; for r in range(10): print 'rob'" File "<string>",...

196
В чем преимущество использования heredoc в PHP? [закрыто]

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

192
Использование переменных внутри bash heredoc

Я пытаюсь интерполировать переменные внутри bash heredoc: var=$1 sudo tee "/path/to/outfile" > /dev/null << "EOF" Some text that contains my $var EOF Это не работает, как я ожидал ( $varтрактуется буквально, а не расширенно). Мне нужно использовать, sudo teeпотому что создание файла...

184
codestyle; поставить Javadoc до или после аннотации?

Я знаю, что это не самая насущная проблема, но я только что понял, что могу поставить блок комментариев Javadoc до или после аннотации. Что бы мы хотели принять в качестве стандарта кодирования? /** * This is a javadoc comment before the annotation */ @Component public class MyClass { @Autowired...