Комментарий конвенций
Picasso 2.0 позволяет вам добавить обратный вызов в запрос.
https://github.com/square/picasso
Обратный вызов, который вы используете, предназначен для «глобального» прослушивателя и помогает отлаживать ошибки, которые могут произойти из-за сети нагрузки.
Используйте load(url).into(view, new Callback() {...}); в Picasso 2.0.
Не забудьте вызвать cancelRequest(target), если вы используете Callback.
6 ответов
Different people have different styles, so to some extent whatever you read here will be just someone's suggestions. There are no cold, hard rules for commenting.
The most important thing you should know about commenting in Java is Javadocing. It's a special type of comment that can be parsed out and used in IDEs (like Eclipse and Netbeans), to help make the coding process easier. Javadoc comments start with a /** and end with a */ It's just like a regular multi-line comment but with two asterisks in the first one.
You put Javadoc comments at the beginning of classes, methods, or instance variables to describe what they do. There are standard ways to format data in the comment, which are tags. Some common tags are @author and @version. You can see some of Sun's suggestions for writing Javadoc comments here: http://java.sun.com/j2se/javadoc/writingdoccomments/
What I like to do after that is use single-line comments ( the double slash // ) to describe my logic. If I need more than one line, I'll just use multiple single-line comments. The advantage of this technique is that if you need to later comment out large swaths of text, you can use the regular multi-line comment /* */ without worrying about the nested comment problem.
I hope that helps you get a rough idea of how to use comments in java. My advice is partly a product of the teaching assistant job I have for a university's Intro Java class and partly from working in industry. Others with different background may have more suggestions.
Я бы следовал рекомендациям по переполнению стека, упомянутым в следующих сообщениях:
Я прокомментирую важные вещи:
Название алгоритма. Например, если я пишу алгоритм для вычисления пикселей в строке между двумя точками, я бы оставил комментарий о том, что это реализация алгоритма Брезенхема.
Если я отправляю жестко закодированное магическое значение в функция (например, true, null, 42 и т. д.) Я бы прокомментировал, что представляет собой это значение.
Если я реализую структуру данных, я люблю комментировать, какие операции она предназначена для оптимизации. Например, если бы я реализовал очередь (по общему признанию, вы бы использовали структуру для очереди), я бы сказал что-то вроде структуры данных FIFO с O (1) вставкой, удалением и размером.
Я пытаюсь оставить комментарий в верхней части каждого класса и метода, имя которого не раскрывает всех тонкостей реализации. Тем не менее, я' Я часто вообще не решаюсь это делать. Чаще всего, когда сталкивается с этой проблемой, рефакторинг более уместен.
Если вы вернетесь к своему коду через две недели и не сможете легко понять, что вы сделали, потребуется либо больше комментариев, либо рефакторинг, чтобы более ясный код.
При этом рекомендации для комментариев должны исходить из правил вашего рабочего места или, в вашем случае, от вашего учителя. Если ваш учитель говорит, что вам не нужны комментарии в определенном месте, тогда вам не нужно.
Когда вы закончите с классом, не стесняйтесь комментировать как хотите.
Комментарии предназначены для читателей кода. Конечно, читатель кода может быть и писателем. Но в любом случае вы хотите рассказать читателю то, что ему нелегко увидеть из кода. Избыточные или повторяющиеся комментарии имеют тенденцию просто не синхронизироваться с реальным кодом.
Прежде всего, читаемый код и читаемые комментарии - это две совершенно разные вещи. Читаемый код - это код, в котором используются хорошие переменные, методы, имена классов и т. Д.
Читаемые комментарии - это скорее вопрос личного вкуса. Некоторым людям нравятся комментарии, которые соответствуют грамматическим правилам, которые будут использоваться при написании книги, в то время как другим наплевать на грамматические вещи.