TODO comments
Sometimes, you need to mark parts of your code for future reference: areas of optimization and improvement, possible changes, questions to be discussed, and so on. IntelliJ IDEA lets you add special types of comments that are highlighted in the editor, indexed, and listed in the TODO tool window. This way you and your teammates can keep track of issues that require attention.
By default, there are two patterns recognized by IntelliJ IDEA: TODO and FIXME in both lower and upper case. These patterns can be used inside line and block comments of any supported file type. You can modify the default patterns or add your own patterns if necessary.
Create a multiline TODO item
- Indent the text in comment lines that follow the initial comment line. You can use spaces and tabs, or a mix of both for indenting multiline TODO items.
Disable multiline TODO items
- Press Control+Alt+S to open the IDE settings and then select Editor | TODO .
- Clear the Treat indented text on the following lines as part of the same TODO checkbox.
View TODO items
- Open the TODO tool window: View | Tool Windows | TODO .
Use tabs to change the source of TODO items you want to view: from all files in your current project, only those in the current file, based on a certain scope of files, or from files in the active changelist (if you have version control integration configured).
To jump to a TODO comment in the source code, click the corresponding TODO item in the TODO tool window. To disable this behavior, use the Navigate with Single Click button on the toolbar (in this case, you will need to double-click the TODO item to jump to the relevant comment).
Add custom patterns and filter TODO items
You can add your own patterns and filter the list to show only TODO items that match certain patterns. For example, you can choose to mark places of possible optimization in your code with the OPTIMIZE pattern and ignore all other types of TODO items when viewing them in the TODO tool window.
- In the Settings dialog ( Control+Alt+S ), select Editor | TODO .
- Use a regular expression to specify a custom pattern. For example, to add a pattern for the word OPTIMIZE in a comment, click in the Patterns section of the TODO dialog, and type the following regular expression:
\boptimize\b.*
This matches the word «optimize» ( \b designates word boundaries) and allows any number of other characters in the comment. Then click OK to save the new pattern.
The icon that you select for a pattern is displayed in the TODO tool window to better distinguish various TODO items. By enabling the Case Sensitive checkbox for a pattern, you can force the pattern to match only with the specified case.
Заметки разработчика
Во время написания кода очень часто возникает ситуация, когда вы заметили какой-либо недочёт в коде, который не настолько критичен, чтобы править его прямо сейчас, но очень желательно исправить его в будущем. Чтобы потом о них не забыть, в таких местах можно оставлять комментарии, предваряя их токеном TODO с двоеточием:
// TODO: здесь требуется оптимизировать код
Тогда все комментарии, в начале которых стоит TODO, будут выводиться в одном окне Task List. Для отображения таких комментариев в выпадающем списке в этом окне выберите «Comments».
Комментарии из всех файлов проекта будут собираться в одном месте. Двойной клик на любой из строк в этом списке тут же переносит вас в соответствующее место в коде. Эдакий план разработки, если нет других более приоритетных задач.
Кроме TODO можно использовать и другие токены. Выберите в Visual Studio меню Tools — Options — Environment — Task List. Там вы увидите список всех доступных по умолчанию токенов, а также сможете добавить свои. Для каждого токена можно задать один из трёх приоритетов (имеет смысл при большом количестве комментариев): низкий (в списке будет отображаться как синяя стрелка вниз), средний (никакой пиктограммы не отображается) и высокий (красный восклицательный знак).
Хочу заметить, что подобный функционал поддерживает любая современная среда разработки, будь то Eclipse или IntelliJ Idea. Причём бывает даже не обязательно писать todo заглавными буквами и не требуется ставить двоеточие.
// todo исправить в ближайшее время
А вообще, старайтесь избегать разрастания списка todo комментариев. Обширные их списки могут демотивировать вас. Вместо того, чтобы написать такой комент, лучше попытайтесь его тут же исправить.
Обучающий проект: ToDo веб приложения на Spring и ReactJS
Приложение будет предназначено для людей, нуждающихся в удобном средстве организации личных целей и задач. Типичное приложение типа todo-list, но с одной особенностью, которая впрочем понятна из названия. Организация задач будет возможна не только в виде списка, но и в виде дерева подзадач. Tree > List!
Проект будет транслироваться с нуля, то есть вплоть до установки необходимого окружения для разработки (JDK, Eclipse, Atom, Node.js) и подключения необходимых зависимостей (Spring, Hibernate, ReactJS, Redux). Если вы хотели увидеть, как используются следующие технологии: Java, Spring, Hibernate, JavaScript, ReactJS, Redux, то спешу вас обрадовать, у вас будет такая возможность! Конечно, это не весь список, но это то на чем будет делаться акцент.
Но стоит отметить, что для понимания будут необходимы некоторые базовые знания языков Java, JavaScript и SQL. В рамках трансляций будут рассмотрены основные методы работы с технологиями по мере того, как они будут встречаться в ходе реального, но небольшого проекта.
Данный подход отличается от простого всестороннего изучения технологий по документации или книгам и он не претендует на всеобъемлемость. Применение больших технологий зачастую схоже с принципом Парето: 20% использования технологии дает 80% результата, а поэтому можно считать, что даже в небольшом проекте, есть хорошая возможность понять суть технологии. И если вы готовы, то давайте вместе пройдем этот путь по разработке простого приложения ToDo Tree с серьёзными промышленными технологиями под капотом. Так что жду всех желающих на стриме!
Необходимые навыки?
- HTML/CSS
- SQL
- Java (желательно 8)
- JavaScript (желательно 6)
- Spring
- Hibernate
- ReactJS + Redux
Данный проект нацелен на аудиторию, которая имеет базовые навыки разработки на Java и JavaScript и желает продвинуть свои знания в современных, и востребованных технологиях разработки web-приложений.
Когда будут проходить трансляции?
Каждую пятницу в 20-00
План разработки ToDo на Spring и ReactJS:
В рамках обучения будет продемонстрирован процесс разработки современного web-приложения, начиная от установки необходимого окружения и заканчивая последней строчкой рабочего приложения.
Этап 1:
- Разработка страницы создания/редактирования задачи
- Разработка страницы фильтрации и сортировки
Как написать простое Android ToDo-приложение на Java
Статьи по различным языкам программирования, реализации различного функционала, приложений.
Предисловие
Я не являюсь профессиональным разработчиком с огромным стажем в данной области (и это даже не хобби, а лишь нужда в разработке конкретного приложения), потому данная статья, полагаю, будет полезна новичкам, таким же, как и я был в начале разработке своего приложения. Возможно, кто-то найдет что-то полезное из данной статьи, какие-то кусочки окажутся частью ваших будущих разработок.
Я расскажу вам как написать простенькое ToDo-приложение на Android с тремя активностями (рабочими экранами).
Ссылка на проект на Github будет в конце данной статьи.
Установка и первичная настройка
Для разработки приложения я рассмотрю использование бесплатной IDE Intellij от разработчиков JetBrains — Android Studio, у меня версия 4.1.1.
После успешной установки IDE и запуска нажимаем на самую первую кнопку Start a new Android Studio Project. Далее появится мастер первичной подготовки проекта:
- выберем подходящий шаблон, в моем случае это Empty Activity — он самый простой для новичков, так как при первом запуске будет всего 1 XML файл с версткой и один java файл MainActivity.
- На следующем экране придумываем имя приложению; помните, что package name, после публикации на Google Play изменить нельзя (иначе Google Play посчитает это другим приложением (поправьте меня, если я ошибаюсь). Выбираем язык Java, так как по нему данная статья, а также, по нему больше информации в Интернете, чем по Kotlin.
- Минимальный SDK выбираем под Android 5.0, так как данного API будет предостаточно для наших задач, заодно мы получим большой охват, в том числе старых устройств: планшеты, смартфоны, встроенные системы.
Далее раскрываем вкладку Project и находим в каталоге Java> файл MainActivity.java , в котором мы будем описывать все происходящее на главном экране.
Подготовка макетов (layouts) — внешний облик приложения
После рассмотрим файл MainActivity.xml , для этого нам нужно найти каталог res>layout>. Откроем MainActivity.xml для создания облика первой — главной страницы и перетягивая с панели Palette необходимые нам типы объектов.
Советую вам размещать объекты под ConstraintLayout, так объекты можно будет привязывать узелками к родительскому ConstraintLayout, который по умолчанию занимает всю пространство, а после привязки узелков, мы можем размещать объекты на нужном нам вертикальном и горизонтальном выравнивании.
Кстати, вместо px, тут используется другая величина — dp, позволяющая на разных экранах видеть одинаковый и желаемый результат.
Кстати, также, советую названия Текст полей переназначать в String значения, чтобы в дальнейшем было проще делать перевод интерфейса — подобный функционал уже встроен в Android Studio. Для этого нажимаем на объект, далее в меню Свойств объекта находим поле text и нажимаем на маленькую плашку-кнопку справа от текста. В открывшимся окне, нажимаем на плюсик слева сверху и создаем название String-переменной и ее значение по умолчанию:
Для перевода интерфейса, необходимо сохранить изменения и над нашим конструктором Layout нажать на кнопку Default (en-us) и выбрать Edit Translations, далее найти слева сверху значок глобуса и нажать на него для добавления нового языка:
Переводы для интерфейсов
Таким образом создадим дополнительные макеты (layouts) для оставшихся двух окон:
Программируем на Java под Android
Еще раз повторюсь, что это Tutorial больше для новичков; дальше я буду комментировать практически каждую строчку. Ссылка на проект на Github будет в конце данной статьи.
Открываем файл Main_Activity.java, который будет отвечать за логику наших переключателей и главного экрана в целом, а она такова:
- В самом верху должен отображаться пользовательский заголовок, если он настроен.
- На переключателях должен отображаться тот текст, который пользователь настраивает из окна с макетом Activity_Settings.xml
- Количество переключателей должно соответствовать заданному числу из окна макета Activity_Advanced.xml
- После выхода из приложения и повторного запуска все переключатели должны оставаться в том же положении, в котором пользователь их оставил
- Сброс переключателей возможен только, если переключатель Уверен/-а? включен.
- А также, должны работать оставшиеся кнопки меню. Ссылка на код на GitHub
Следующим этапом будет написание кода для корректной работы макета Activity_Settings.XML, а логика его такова:
- Введенные пользователь записи сохраняются даже после перезапуска приложения
- Количество полей соответствуют числу, заданному в настройках из макета Activity_Advanced.xml
- А также, должны работать оставшиеся кнопки меню.
И наконец опишем логику работы последнего окна в приложении — с Дополнительными настройками:
- Количество полей для отображения — в данном случае выбор с помощью радиокнопок — 6, 7 или 8 полей.
- Текстовый заголовок, который пользователь может ввести и который будет отображаться на главной странице/активности.
- Также, текстовый заголовок и выбранное количество полей с помощью радиокнопок должны сохранять свое состояние даже после перезапуска приложения.
- И наконец должны работать оставшиеся кнопки меню.
Подготовка приложения к публикации
Для отладки и проверки работоспособности приложения советую вам использовать настоящее устройство на Android, так вы сразу сможете отследить наличие, как минимум проблем с оформлением.
Здесь я приложил видео-инструкцию, как подключить свой смартфон к Android studio для отладки вашего приложения. На видео вы можете заметить первую версию данного приложения с очень плохим кодом:
Регистрация в Google Play
Для публикации приложения нам следует создать специальный аккаунт разработчика, вот прямая ссылка.
Далее вам предстоит оплатить пошлину в $35 за возможность публиковать приложения, это почти в 3 раза дешевле, чем в Steam, при том, что Steam просит $100 за каждое публикуемое приложение/игру, даже бесплатное, а с аккаунтом разработка, в Google Play вы можете публиковать несчётное множество приложений.
После оплаты и успешной авторизации в консоли разработчика, необходимо нажать на синюю кнопку «Создать приложение«, далее заполнить все необходимые поля:
После создания приложения в консоли разработчика Google Play, необходимо перейти в раздел Рабочая версия и нажать на кнопку Создать новый выпуск. Вам предложат получить электронную подпись для вашего приложения с расширением *.jks, с помощью которой вам предстоит подписать свое первое приложение, а также, все дальнейшие выпуски с обновлениями.
Возвращаемся в Android Studio и необходимо заполнить немного информации о нашем приложении, для этого нажимаем File>Project Structure и заполняем поля Version Code и Version Name — без них Google Play Google Play не допустит ваше приложение до публикации:
Наконец, переходим в следующий раздел: пункт меню Build>Generate Signed Bundle / APK
В открывшимся окне выбираем APK. В подразделе Key Store Path выбираем Create new, далее заполняем все поля (прямая ссылка на официальную инструкцию), далее данный ключ потребуется загрузить в консоль Google Play. Затем вернемся в Android Studio и после ввода всех необходимых данных, нажимаем Next
В следующем окне отмечаем все чекбоксы, выбираем release и нажимаем Finish — Android Studio скомпилирует подписанное приложение, которое можно опубликовать в Google Play.
Итог
После загрузки файла приложения APK потребуется заполнить множество форм и подготовить множество материалов: описание на разных языках (если необходимо), изображения на разных языках (надписи на изображениях я имею в виду), логотипы, иконки разных размеров, скриншоты со смартфона и планшета.
Наконец отправляем приложение в публикацию. Сотрудники Google Play будут проверять ваше приложение в течении 2 недель, судя по официальным данным. Данное приложение рассматривали в течении 5 суток. Также, стоит учесть, что каждое обновление, также, будут проверять, но на обновления уходит не более 2-3 суток.