Написание JavaDoc для метода [duplicate]
Еще один подход к возврату значения из асинхронной функции - передать объект, который сохранит результат от асинхронной функции.
Вот пример того же:
var async = require("async");
// This wires up result back to the caller
var result = {};
var asyncTasks = [];
asyncTasks.push(function(_callback){
// some asynchronous operation
$.ajax({
url: '...',
success: function(response) {
result.response = response;
_callback();
}
});
});
async.parallel(asyncTasks, function(){
// result is available after performing asynchronous operation
console.log(result)
console.log('Done');
});
Я использую объект result для хранения значения во время асинхронной операции. Это позволяет получить результат даже после асинхронного задания.
Я использую этот подход много. Мне было бы интересно узнать, насколько хорошо этот подход работает, когда задействован результат обратно через последовательные модули.
11 ответов
Как насчет исходного кода JDK, но доступ к нему через стороннюю сторону, например, docjar? Например, источник Collections .
Таким образом, нет большой загрузки.
-
1– cherouvim 3 July 2009 в 18:00
-
2– Gordon Gustafson 6 October 2013 в 20:11
-
3– Sri Harsha Chilakapati 9 December 2014 в 14:18
-
4– ThePyroEagle 4 May 2016 в 19:38
-
5– Book Of Zeus 23 March 2018 в 03:32
-
1– Jason S 3 July 2009 в 16:00
-
2– Michael Borgwardt 3 July 2009 в 17:03
Я использую небольшой набор шаблонов документации:
- всегда документирует информацию о безопасности потоков
- , всегда документируя неизменяемость
- javadoc с примерами (например, Formatter )
- @Deprecation с помощью WHY и HOW для замены аннотированного элемента
Посмотрите на источник Spring, он имеет отличные javadocs
-
1– Pedantic 18 February 2014 в 06:47
ANT например - исходный код доступен в Интернете: http://svn.apache.org/viewvc/ant/core/trunk/src/main/org/apache/tools/ant/DefaultLogger.java?view = co
Чтобы выбрать другие файлы, начиная с: http://svn.apache.org/viewvc/ant/core/trunk/src/main/org/apache/tools / муравей /? pathrev = 761528
Если вы используете Eclipse, вы можете настроить JDK (не JRE ) в установленных JRE, а затем использовать Open Type (Ctrl + Shift + T), дайте что-то вроде java.util.Collections
-
1– ThePyroEagle 4 May 2016 в 19:40
Если все, что вы ищете, это синтаксис, то это может помочь:
-
1– Jason S 3 July 2009 в 16:23
-
2– Alexey Ivanov 26 October 2015 в 07:58
Документация пакета и классов Google Guava EventBus - хороший пример Javadoc. Особенно хорошо написана документация по упаковке с быстрым запуском.
Загрузите источники Lucene и посмотрите, как они это делают. У них хорошие JavaDocs.
Страница Как записать Doc Coments для инструмента Javadoc содержит большое количество хороших примеров. Один раздел называется Примеры комментариев Doc и содержит довольно много обычаев.
Кроме того, в Javadoc FAQ содержится еще несколько примеров для иллюстрации ответов.
-
1– Jeff Evans 12 December 2012 в 18:23
Если вы устанавливаете JDK и выбираете также установку источников, src.zip содержит источник ВСЕХ общедоступных классов Java. Большинство из них имеют довольно хороший javadoc.