С 05.07 по 11.07
Предыдущий пост(с 28.06 по 04.07)
Воскресный мотивационный пост:
Ты не хочешь стать программистом
Выбранная голосованием тема:
Обзор IO и NIO в Java
Запись встреч/видео:
Немного о неблокирующих запросах на внешние API с WebFlux, на примере Dadata.ru
Обучающие статьи:
Профили, настройки и переменные в Maven
Модульность и многомодульные проекты в Maven
Расширенные темы и интеграции Maven
Конвенции именования в Java
Операторы в Java
Полезные статьи и видео:
Лучшие практики создания отказоустойчивых систем
Хэши: виды, применение и примеры на Java
SOLID принципы, нужны ли они?
Как и всегда, задачи можно найти под тегом - #Tasks, вопросы с собеседований - #собеседование
#memory
Предыдущий пост(с 28.06 по 04.07)
Воскресный мотивационный пост:
Ты не хочешь стать программистом
Выбранная голосованием тема:
Обзор IO и NIO в Java
Запись встреч/видео:
Немного о неблокирующих запросах на внешние API с WebFlux, на примере Dadata.ru
Обучающие статьи:
Профили, настройки и переменные в Maven
Модульность и многомодульные проекты в Maven
Расширенные темы и интеграции Maven
Конвенции именования в Java
Операторы в Java
Полезные статьи и видео:
Лучшие практики создания отказоустойчивых систем
Хэши: виды, применение и примеры на Java
SOLID принципы, нужны ли они?
Как и всегда, задачи можно найти под тегом - #Tasks, вопросы с собеседований - #собеседование
#memory
👍1
Maven в IntelliJ IDEA: Встроенный Maven и его роль
Как работает встроенный Maven
Расположение: IntelliJ IDEA включает Maven в свою установку (обычно в <IntelliJ IDEA installation>/plugins/maven/lib).
Версия: IDEA использует конкретную версию Maven (например, 3.8.6 в последних версиях), которая обновляется с новыми релизами IDE.
Интеграция: IDEA вызывает Maven через внутренний API, а не через командную строку. Это позволяет управлять сборкой, зависимостями и плагинами из интерфейса IDE.
Конфигурация: Настройки хранятся в File > Settings > Build, Execution, Deployment > Build Tools > Maven:
Maven home path: По умолчанию Bundled (Maven).
User settings file: Можно указать ~/.m2/settings.xml.
Local repository: По умолчанию ~/.m2/repository, но можно настроить.
В памяти: Встроенный Maven загружается в JVM IntelliJ IDEA, разделяя память с IDE. Это увеличивает общее потребление памяти, особенно при выполнении сложных сборок. IDEA кэширует зависимости в ~/.m2/repository, синхронизируя их с системным Maven.
Замена системного Maven
IntelliJ IDEA по умолчанию использует встроенный Maven, но позволяет переключиться на системный:
Переключение на системный Maven:
Откройте File > Settings > Build, Execution, Deployment > Build Tools > Maven.
В поле Maven home path выберите путь к системной установке (например, C:\Program Files\Apache\maven-3.8.6 или /opt/apache-maven-3.8.6).
Перезапустите проект для применения изменений.
Почему встроенный Maven заменяет системный:
Удобство: Встроенный Maven не требует установки, что упрощает начало работы.
Совместимость: IDEA гарантирует совместимость встроенного Maven с функциями IDE (например, автодополнение в POM.xml, интеграция с dependency:tree).
Изоляция: Встроенный Maven изолирован от системных изменений (например, обновления системного Maven), обеспечивая стабильность.
Кэширование: IDEA использует тот же локальный репозиторий (~/.m2/repository), что и системный Maven, минимизируя дублирование данных.
Когда использовать системный Maven:
Для согласованности с CI/CD, где требуется конкретная версия Maven.
При использовании Maven Wrapper (mvnw), который игнорирует встроенный Maven.
Для кастомных расширений или плагинов, требующих специфической версии Maven.
При работе в терминале или на серверах без IDE.
В памяти: Системный Maven запускается как отдельный процесс, что изолирует его от памяти IDEA, но требует дополнительных ресурсов для запуска JVM. Встроенный Maven экономит ресурсы, так как работает в той же JVM, но может конфликтовать с другими задачами IDE.
Нюансы интеграции
Конфликты версий: Если системный и встроенный Maven используют разные версии, могут возникнуть несовместимости в поведении плагинов или разрешении зависимостей. Используйте mvnw или настройте IDEA на системный Maven.
Настройки: Встроенный Maven использует ~/.m2/settings.xml, если он существует, но IDEA позволяет переопределить настройки через интерфейс.
Производительность: Встроенный Maven может быть медленнее в IDE из-за конкуренции за ресурсы JVM. Для крупных проектов рекомендуется системный Maven с -T для параллельной сборки.
Отладка: IDEA предоставляет графический интерфейс для выполнения Maven-целей (Run > Maven > Lifecycle), но для детальной отладки используйте терминал с -X или -e.
#Java #middle #Maven_In_IntelljIDEA
Как работает встроенный Maven
Расположение: IntelliJ IDEA включает Maven в свою установку (обычно в <IntelliJ IDEA installation>/plugins/maven/lib).
Версия: IDEA использует конкретную версию Maven (например, 3.8.6 в последних версиях), которая обновляется с новыми релизами IDE.
Интеграция: IDEA вызывает Maven через внутренний API, а не через командную строку. Это позволяет управлять сборкой, зависимостями и плагинами из интерфейса IDE.
Конфигурация: Настройки хранятся в File > Settings > Build, Execution, Deployment > Build Tools > Maven:
Maven home path: По умолчанию Bundled (Maven).
User settings file: Можно указать ~/.m2/settings.xml.
Local repository: По умолчанию ~/.m2/repository, но можно настроить.
В памяти: Встроенный Maven загружается в JVM IntelliJ IDEA, разделяя память с IDE. Это увеличивает общее потребление памяти, особенно при выполнении сложных сборок. IDEA кэширует зависимости в ~/.m2/repository, синхронизируя их с системным Maven.
Замена системного Maven
IntelliJ IDEA по умолчанию использует встроенный Maven, но позволяет переключиться на системный:
Переключение на системный Maven:
Откройте File > Settings > Build, Execution, Deployment > Build Tools > Maven.
В поле Maven home path выберите путь к системной установке (например, C:\Program Files\Apache\maven-3.8.6 или /opt/apache-maven-3.8.6).
Перезапустите проект для применения изменений.
Почему встроенный Maven заменяет системный:
Удобство: Встроенный Maven не требует установки, что упрощает начало работы.
Совместимость: IDEA гарантирует совместимость встроенного Maven с функциями IDE (например, автодополнение в POM.xml, интеграция с dependency:tree).
Изоляция: Встроенный Maven изолирован от системных изменений (например, обновления системного Maven), обеспечивая стабильность.
Кэширование: IDEA использует тот же локальный репозиторий (~/.m2/repository), что и системный Maven, минимизируя дублирование данных.
Когда использовать системный Maven:
Для согласованности с CI/CD, где требуется конкретная версия Maven.
При использовании Maven Wrapper (mvnw), который игнорирует встроенный Maven.
Для кастомных расширений или плагинов, требующих специфической версии Maven.
При работе в терминале или на серверах без IDE.
В памяти: Системный Maven запускается как отдельный процесс, что изолирует его от памяти IDEA, но требует дополнительных ресурсов для запуска JVM. Встроенный Maven экономит ресурсы, так как работает в той же JVM, но может конфликтовать с другими задачами IDE.
Нюансы интеграции
Конфликты версий: Если системный и встроенный Maven используют разные версии, могут возникнуть несовместимости в поведении плагинов или разрешении зависимостей. Используйте mvnw или настройте IDEA на системный Maven.
Настройки: Встроенный Maven использует ~/.m2/settings.xml, если он существует, но IDEA позволяет переопределить настройки через интерфейс.
Производительность: Встроенный Maven может быть медленнее в IDE из-за конкуренции за ресурсы JVM. Для крупных проектов рекомендуется системный Maven с -T для параллельной сборки.
Отладка: IDEA предоставляет графический интерфейс для выполнения Maven-целей (Run > Maven > Lifecycle), но для детальной отладки используйте терминал с -X или -e.
#Java #middle #Maven_In_IntelljIDEA
👍2
Нюансы и внутренние механизмы
Управление памятью:
Maven загружает модель POM, зависимости и плагины в память JVM. Для крупных проектов с сотнями зависимостей потребление памяти может достигать нескольких гигабайт.
Встроенный Maven в IDEA разделяет память с IDE, что может привести к перегрузке при выполнении ресурсоемких задач (например, компиляция или тестирование).
Системный Maven запускается отдельно, что изолирует его, но увеличивает общее потребление памяти системы.
Оптимизируйте с помощью JVM-флагов: -Xmx2048m для увеличения кучи.
Кэширование:
Локальный репозиторий (~/.m2/repository) используется обоими вариантами Maven, минимизируя дублирование артефактов.
Встроенный Maven в IDEA кэширует результаты сборки в памяти IDE, что ускоряет повторные операции, но увеличивает нагрузку на JVM.
Совместимость:
Убедитесь, что версия JDK, указанная в JAVA_HOME, совместима с Maven (например, Maven 3.8.6 требует JDK 7+).
Разные версии Maven могут по-разному интерпретировать POM.xml. Используйте mvnw для согласованности.
Безопасность:
Храните учетные данные для репозиториев в зашифрованном виде в ~/.m2/settings-security.xml.
Ограничьте доступ к ~/.m2 на Linux: chmod 700 ~/.m2.
Отладка:
Используйте mvn -X для вывода подробных логов о загрузке плагинов и зависимостей.
В IDEA откройте вкладку "Maven" для выполнения целей и анализа вывода.
Проверьте итоговую конфигурацию: mvn help:effective-pom или mvn help:effective-settings.
Производительность:
Системный Maven позволяет использовать флаг -T для параллельной сборки, что быстрее для многомодульных проектов.
Встроенный Maven в IDEA может быть ограничен настройками JVM IDE. Настройте idea64.exe.vmoptions для увеличения памяти.
#Java #middle #Maven_In_IntelljIDEA
Управление памятью:
Maven загружает модель POM, зависимости и плагины в память JVM. Для крупных проектов с сотнями зависимостей потребление памяти может достигать нескольких гигабайт.
Встроенный Maven в IDEA разделяет память с IDE, что может привести к перегрузке при выполнении ресурсоемких задач (например, компиляция или тестирование).
Системный Maven запускается отдельно, что изолирует его, но увеличивает общее потребление памяти системы.
Оптимизируйте с помощью JVM-флагов: -Xmx2048m для увеличения кучи.
Кэширование:
Локальный репозиторий (~/.m2/repository) используется обоими вариантами Maven, минимизируя дублирование артефактов.
Встроенный Maven в IDEA кэширует результаты сборки в памяти IDE, что ускоряет повторные операции, но увеличивает нагрузку на JVM.
Совместимость:
Убедитесь, что версия JDK, указанная в JAVA_HOME, совместима с Maven (например, Maven 3.8.6 требует JDK 7+).
Разные версии Maven могут по-разному интерпретировать POM.xml. Используйте mvnw для согласованности.
Безопасность:
Храните учетные данные для репозиториев в зашифрованном виде в ~/.m2/settings-security.xml.
Ограничьте доступ к ~/.m2 на Linux: chmod 700 ~/.m2.
Отладка:
Используйте mvn -X для вывода подробных логов о загрузке плагинов и зависимостей.
В IDEA откройте вкладку "Maven" для выполнения целей и анализа вывода.
Проверьте итоговую конфигурацию: mvn help:effective-pom или mvn help:effective-settings.
Производительность:
Системный Maven позволяет использовать флаг -T для параллельной сборки, что быстрее для многомодульных проектов.
Встроенный Maven в IDEA может быть ограничен настройками JVM IDE. Настройте idea64.exe.vmoptions для увеличения памяти.
#Java #middle #Maven_In_IntelljIDEA
👍2
Оглавление.
Jackson
Jackson. Быстрая сериализация и десериализация объектов
Ключевые аннотации для сериализации.
Аннотации Jackson для десериализации и изменения структуры JSON
Работа со списками, картами и вложенными объектами
Кастомные десериализаторы
Глобальная настройка ObjectMapper: как управлять сериализацией и десериализацией
Использование модулей в Jackson: JavaTimeModule и работа с Java 8 датами
Частичная сериализация с помощью @JsonView
Tree Model и Streaming API в Jackson: когда нужна гибкость и производительность
Jackson
Jackson. Быстрая сериализация и десериализация объектов
Ключевые аннотации для сериализации.
Аннотации Jackson для десериализации и изменения структуры JSON
Работа со списками, картами и вложенными объектами
Кастомные десериализаторы
Глобальная настройка ObjectMapper: как управлять сериализацией и десериализацией
Использование модулей в Jackson: JavaTimeModule и работа с Java 8 датами
Частичная сериализация с помощью @JsonView
Tree Model и Streaming API в Jackson: когда нужна гибкость и производительность
Оглавление.
Введение в Apache Maven: автоматизация сборки и управления проектами
Архитектура Maven и философия Convention over Configuration
Руководство по POM (Project Object Model) в Maven
Жизненный цикл Maven: Полное понимание фаз и процессов
Плагины и цели Maven
Управление зависимостями в Maven
Профили, настройки и переменные в Maven
Модульность и многомодульные проекты в Maven
Расширенные темы и интеграции Maven
Введение в Apache Maven: автоматизация сборки и управления проектами
Архитектура Maven и философия Convention over Configuration
Руководство по POM (Project Object Model) в Maven
Жизненный цикл Maven: Полное понимание фаз и процессов
Плагины и цели Maven
Управление зависимостями в Maven
Профили, настройки и переменные в Maven
Модульность и многомодульные проекты в Maven
Расширенные темы и интеграции Maven
Оглавление.
Раздел 2: Базовый синтаксис Java.
Глава 1. Структура простой программы
Классы в Java: синтаксис и структура
Методы в Java — синтаксис и структура
Идентификаторы доступа в Java
Конвенции именования в Java
Операторы в Java
Комментарии: однострочные (//), многострочные (/* */), Javadoc (/** */)
Ключевые слова и зарезервированные слова в Java
Раздел 2: Базовый синтаксис Java.
Глава 1. Структура простой программы
Классы в Java: синтаксис и структура
Методы в Java — синтаксис и структура
Идентификаторы доступа в Java
Конвенции именования в Java
Операторы в Java
Комментарии: однострочные (//), многострочные (/* */), Javadoc (/** */)
Ключевые слова и зарезервированные слова в Java
Оглавление.
Раздел 3: Типы данных и переменные
Примитивные типы данных в Java
Глава 1. Целочисленные значения.
Глубокое изучение типа данных byte в Java
Полный разбор примитивного типа int в Java
Глубокое изучение типа данных short в Java
Глубокое изучение типа данных long в Java
Глава 2. Числа с плавающей точкой.
Глубокое изучение типа данных double в Java
Глубокое изучение типа float в Java
Глава 3. Символьные значения.
Глубокое изучение типа данных char в Java
Глава 4. Логические значения.
Глубокое изучение типа данных boolean в Java
Ссылочные типы (Reference Types)
Глава 5.
Объекты в Java
Ссылочные типы в Java — массивы
Ссылочные типы в Java — строки (String)
Ссылочные типы в Java — интерфейсы (interfaces)
Ссылочные типы в Java — var
Глава 6. Особые случаи
Null - отсутствие ссылки в Java
Автоупаковка и автораспаковка типов в Java
Раздел 3: Типы данных и переменные
Примитивные типы данных в Java
Глава 1. Целочисленные значения.
Глубокое изучение типа данных byte в Java
Полный разбор примитивного типа int в Java
Глубокое изучение типа данных short в Java
Глубокое изучение типа данных long в Java
Глава 2. Числа с плавающей точкой.
Глубокое изучение типа данных double в Java
Глубокое изучение типа float в Java
Глава 3. Символьные значения.
Глубокое изучение типа данных char в Java
Глава 4. Логические значения.
Глубокое изучение типа данных boolean в Java
Ссылочные типы (Reference Types)
Глава 5.
Объекты в Java
Ссылочные типы в Java — массивы
Ссылочные типы в Java — строки (String)
Ссылочные типы в Java — интерфейсы (interfaces)
Ссылочные типы в Java — var
Глава 6. Особые случаи
Null - отсутствие ссылки в Java
Автоупаковка и автораспаковка типов в Java
👍2
Всем привет! ✌️
Сегодня вместо еженедельного мотивационного поста хочу поделиться мыслями о канале.
Для многих из Вас, не важно подписчик или гость - этот канал один из тысячи пытающихся развиться на хайпе программирования.
И я Вас понимаю.
Сам периодически просматриваю подборки, где 90% это созданные для спама рекламы, псевдопрограммерские Java - каналы с парой постов в неделю.
Конечно же есть и интересные. Не спорю. Но их меньшинство.
Многие просто паразитируют на чужом контенте выкладывая ссылки на интересные видео и статьи.
Чем же отличается этот канал?🤨
Тем, что это канал - библиотека. Канал, где Вы реально можете изучить java с нуля.
Тут уже есть для этого весь материал.
Есть задачи, есть голосования по тем темам которые Вам интересны, есть встречи где это можно все обсудить. Есть даже проекты в которых мы обучаемся командному взаимодействию и web-разработке.
Зачем мне все это?🧐
Для меня канал давно перерос из какого-то мелкого хобби в серьезный проект. Я не зарабатываю на нем деньги. Я не потратил ни копейки на рекламу.
Я просто ежедневно готовлю для Вас контент. Думаю о какой теме написать, какую задачу сообразить, где взять новый и уникальный факт)))
Моя цель - объединить в канале тех, кто действительно хочет постоянно обучаться java, тех, кто болеет этим как и я☺️
Кто хочет наладить постоянный обмен мнениями, взаимодействие, обсуждение.
Найти тех, кто не побоится задавать и отвечать на вопросы других людей.
Жаль, что этого не происходит и я не знаю почему.
Ведь если взять отдельного взятого подписчика, он окажется адекватным и интересным человеком, у которого на самом деле много вопросов и предложений.
Но в массе почти 700 человек, большинству лень даже выбрать кнопку в голосовалке😏
И я откровенно этого не понимаю.
То ли это какой-то страх публичности. То ли ЧСВ.
Порой хочется переделать канал в закрытое сообщество с реально активными участниками))))
Поэтому обращусь к тем, кто читает сейчас этот пост 🫵
Если Вам интересен этот канал, его контент - давайте обратную связь.
Не бойтесь спрашивать, обсуждать, предлагать. Я буду рад любой реакции. Ведь только так можно развиваться.
Не стесняйтесь, просить те темы, которые интересны лично Вам, возможно они еще кому-то понравятся!
Давайте объединяться, делиться мнениями, помогать друг другу. Зовите сюда заинтересованных друзей, вместе точно будет интереснее.
Ведь это бесплатно🤣
И кстати, возможно среди Вас есть и те, кто хочет попробовать быть редактором канала. Пишите - я с радостью приму помощь🙂
@Oleborn😎
Сегодня вместо еженедельного мотивационного поста хочу поделиться мыслями о канале.
Для многих из Вас, не важно подписчик или гость - этот канал один из тысячи пытающихся развиться на хайпе программирования.
И я Вас понимаю.
Сам периодически просматриваю подборки, где 90% это созданные для спама рекламы, псевдопрограммерские Java - каналы с парой постов в неделю.
Конечно же есть и интересные. Не спорю. Но их меньшинство.
Многие просто паразитируют на чужом контенте выкладывая ссылки на интересные видео и статьи.
Чем же отличается этот канал?
Тем, что это канал - библиотека. Канал, где Вы реально можете изучить java с нуля.
Тут уже есть для этого весь материал.
Есть задачи, есть голосования по тем темам которые Вам интересны, есть встречи где это можно все обсудить. Есть даже проекты в которых мы обучаемся командному взаимодействию и web-разработке.
Зачем мне все это?
Для меня канал давно перерос из какого-то мелкого хобби в серьезный проект. Я не зарабатываю на нем деньги. Я не потратил ни копейки на рекламу.
Я просто ежедневно готовлю для Вас контент. Думаю о какой теме написать, какую задачу сообразить, где взять новый и уникальный факт)))
Моя цель - объединить в канале тех, кто действительно хочет постоянно обучаться java, тех, кто болеет этим как и я
Кто хочет наладить постоянный обмен мнениями, взаимодействие, обсуждение.
Найти тех, кто не побоится задавать и отвечать на вопросы других людей.
Жаль, что этого не происходит и я не знаю почему.
Ведь если взять отдельного взятого подписчика, он окажется адекватным и интересным человеком, у которого на самом деле много вопросов и предложений.
Но в массе почти 700 человек, большинству лень даже выбрать кнопку в голосовалке
И я откровенно этого не понимаю.
То ли это какой-то страх публичности. То ли ЧСВ.
Порой хочется переделать канал в закрытое сообщество с реально активными участниками))))
Поэтому обращусь к тем, кто читает сейчас этот пост 🫵
Если Вам интересен этот канал, его контент - давайте обратную связь.
Не бойтесь спрашивать, обсуждать, предлагать. Я буду рад любой реакции. Ведь только так можно развиваться.
Не стесняйтесь, просить те темы, которые интересны лично Вам, возможно они еще кому-то понравятся!
Давайте объединяться, делиться мнениями, помогать друг другу. Зовите сюда заинтересованных друзей, вместе точно будет интереснее.
Ведь это бесплатно
И кстати, возможно среди Вас есть и те, кто хочет попробовать быть редактором канала. Пишите - я с радостью приму помощь
@Oleborn
Please open Telegram to view this post
VIEW IN TELEGRAM
👍14
Давайте проверим активность на канале. Любопытно сколько людей реально постоянно читают 🧐
Anonymous Poll
61%
Я тут! Все ок! 😉
32%
И я тут! С вами! 🏝
6%
А я не тут. Я тама 🗿
Предлагаем темы для разбора и публикации! 📖
В комментариях к данному посту предлагайте вопросы, которые вы хотели бы увидеть максимально подробно разобранными в постах, а если будет интересно то и на видео.
Голосование будет проводиться всю неделю, а статья или видео - выходить по выходным.
Примерные правила:
🟢 темы, не выше уровня middle, чтоб был интерес общим.
🟢 Один человек - одна тема.
🟢 Тема должна быть отдельным теоретически-практическим вопросом. Готовый проект - это не тема!
Жду Ваших предложений!👏
В комментариях к данному посту предлагайте вопросы, которые вы хотели бы увидеть максимально подробно разобранными в постах, а если будет интересно то и на видео.
Голосование будет проводиться всю неделю, а статья или видео - выходить по выходным.
Примерные правила:
Жду Ваших предложений!
Please open Telegram to view this post
VIEW IN TELEGRAM
👍2
Выбираем темы для рассмотрения в следующие выходные! 🤨
Anonymous Poll
33%
OkHttp
17%
AOP
8%
HATEOS
42%
Minecraft Forge API
👍2
(периодически обновляемое)
Если хотите найти информацию по Java, ранее опубликованную на канале - для Вас подготовлено оглавление!
Обновлено оглавление (12.07.25)
Читайте, используйте, будут вопросы - пишите!
Please open Telegram to view this post
VIEW IN TELEGRAM
👍6
Java for Beginner pinned «☄️ Оглавление для обучающих постов. (периодически обновляемое) Если хотите найти информацию по Java, ранее опубликованную на канале - для Вас подготовлено оглавление! ✔️ Пользуйтесь на здоровье! 🔜 Часть 1. 🔜 Часть 2. 🔜 Часть 3. SPRING 🔜 Часть 4. SPRING…»
А вы знали, что первой социальной платформой, в которой появились виртуальное представление личности пользователя уже в современном понимании и виде, был Snapchat?
В 2016 году компания Snap приобрела Bitmoji и материнскую компанию Bitstrips за 64,2 миллиона долларов и добавила в Snapchat возможность настраивать цифровые аватары.
Proof
#facts
Please open Telegram to view this post
VIEW IN TELEGRAM
🔥1
"Автоматизация процессов начинается с автоматизации мышления."
Георгий Лопато, разработчик советских ЭВМ, сказал это в 1970 году на конференции в Минске.
Биография
#Citation #Biography
Please open Telegram to view this post
VIEW IN TELEGRAM
Wikipedia
Лопато, Георгий Павлович
Георгий Павлович Лопато (23 августа 1924 (1924-08-23) — 13 февраля 2003) — советский учёный, ветеран вычислительной техники. Член-корреспондент АН СССР (1979) и член-корреспондент НАН Белоруссии.
👍1
Комментарии в Java
1. Что такое комментарии в Java?
Комментарии — это части исходного кода, которые игнорируются компилятором Java и не включаются в скомпилированный байт-код. Они предназначены для добавления пояснений, документации или временного исключения кода из выполнения. В Java существуют три типа комментариев: однострочные, многострочные и Javadoc, каждый из которых имеет свои особенности и области применения.
Зачем нужны комментарии?
Документация: Объясняют назначение кода, классов, методов и сложных алгоритмов.
Читаемость: Упрощают понимание кода другими разработчиками или при возвращении к проекту спустя время.
Поддержка API: Javadoc-комментарии используются для генерации документации API.
Отладка: Позволяют временно исключать фрагменты кода без их удаления.
Командная работа: Унифицируют понимание кода в команде, особенно в больших проектах.
2. Синтаксис комментариев
Java поддерживает три типа комментариев, каждый из которых имеет уникальный синтаксис и назначение.
2.1. Однострочные комментарии (//)
Описание: Начинаются с // и продолжаются до конца строки.
Применение: Используются для коротких пояснений или аннотаций к отдельным строкам кода.
Синтаксис:
2.2. Многострочные комментарии (/* */)
Описание: Начинаются с /* и заканчиваются */, охватывая одну или несколько строк.
Применение: Используются для более длинных пояснений или временного исключения блока кода.
Синтаксис:
2.3. Javadoc-комментарии (/** */)
Описание: Начинаются с /** и заканчиваются */, используются для генерации документации API.
Применение: Документируют классы, методы, поля и пакеты, включая теги, такие как @param, @return и т.д.
Синтаксис:
Примечания к синтаксису:
Комментарии не могут быть вложенными. Например, нельзя поместить /* */ внутрь другого /* */.
Javadoc-комментарии обрабатываются инструментом javadoc для создания HTML-документации.
Однострочные комментарии могут следовать за кодом в той же строке, в то время как многострочные и Javadoc-комментарии обычно размещаются перед кодом.
3. Типы комментариев и их особенности
3.1. Однострочные комментарии (//)
Назначение: Используются для кратких пояснений, аннотаций к переменным или временных заметок.
Особенности:
Игнорируются компилятором.
Подходят для пояснений, которые не требуют много текста.
Часто используются для "инлайн"-комментариев (например, после строки кода).
Пример:
3.2. Многострочные комментарии (/* */)
Назначение: Используются для описания сложной логики, временного исключения кода или добавления заметок, которые не помещаются в одну строку.
Особенности:
Могут охватывать несколько строк, что делает их удобными для больших пояснений.
Часто используются для комментирования блоков кода при отладке.
Не поддерживают вложенность (например, /* /* */ */ вызовет ошибку).
Пример:
3.3. Javadoc-комментарии (/** */)
Назначение: Используются для документирования кода и генерации профессиональной документации API.
Особенности:
Поддерживают специальные теги (например, @param, @return, @throws) для описания параметров, возвращаемых значений и исключений.
Используются инструментом javadoc для создания HTML-документации.
Обычно размещаются непосредственно перед классами, методами или полями.
#Java #для_новичков #beginner #java_syntax #commentaries
1. Что такое комментарии в Java?
Комментарии — это части исходного кода, которые игнорируются компилятором Java и не включаются в скомпилированный байт-код. Они предназначены для добавления пояснений, документации или временного исключения кода из выполнения. В Java существуют три типа комментариев: однострочные, многострочные и Javadoc, каждый из которых имеет свои особенности и области применения.
Зачем нужны комментарии?
Документация: Объясняют назначение кода, классов, методов и сложных алгоритмов.
Читаемость: Упрощают понимание кода другими разработчиками или при возвращении к проекту спустя время.
Поддержка API: Javadoc-комментарии используются для генерации документации API.
Отладка: Позволяют временно исключать фрагменты кода без их удаления.
Командная работа: Унифицируют понимание кода в команде, особенно в больших проектах.
2. Синтаксис комментариев
Java поддерживает три типа комментариев, каждый из которых имеет уникальный синтаксис и назначение.
2.1. Однострочные комментарии (//)
Описание: Начинаются с // и продолжаются до конца строки.
Применение: Используются для коротких пояснений или аннотаций к отдельным строкам кода.
Синтаксис:
// Это однострочный комментарий
int x = 10; // Устанавливаем начальное значение x
2.2. Многострочные комментарии (/* */)
Описание: Начинаются с /* и заканчиваются */, охватывая одну или несколько строк.
Применение: Используются для более длинных пояснений или временного исключения блока кода.
Синтаксис:
/* Это многострочный комментарий.
Он может занимать несколько строк.
Используется для описания сложной логики. */
int y = 20;
2.3. Javadoc-комментарии (/** */)
Описание: Начинаются с /** и заканчиваются */, используются для генерации документации API.
Применение: Документируют классы, методы, поля и пакеты, включая теги, такие как @param, @return и т.д.
Синтаксис:
/**
* Вычисляет сумму двух чисел.
* @param a Первое число
* @param b Второе число
* @return Сумма чисел
*/
public int add(int a, int b) {
return a + b;
}
Примечания к синтаксису:
Комментарии не могут быть вложенными. Например, нельзя поместить /* */ внутрь другого /* */.
Javadoc-комментарии обрабатываются инструментом javadoc для создания HTML-документации.
Однострочные комментарии могут следовать за кодом в той же строке, в то время как многострочные и Javadoc-комментарии обычно размещаются перед кодом.
3. Типы комментариев и их особенности
3.1. Однострочные комментарии (//)
Назначение: Используются для кратких пояснений, аннотаций к переменным или временных заметок.
Особенности:
Игнорируются компилятором.
Подходят для пояснений, которые не требуют много текста.
Часто используются для "инлайн"-комментариев (например, после строки кода).
Пример:
int counter = 0; // Счетчик для отслеживания итераций
counter++; // Увеличиваем счетчик
3.2. Многострочные комментарии (/* */)
Назначение: Используются для описания сложной логики, временного исключения кода или добавления заметок, которые не помещаются в одну строку.
Особенности:
Могут охватывать несколько строк, что делает их удобными для больших пояснений.
Часто используются для комментирования блоков кода при отладке.
Не поддерживают вложенность (например, /* /* */ */ вызовет ошибку).
Пример:
/* Этот метод временно отключен для отладки.
Он будет восстановлен после тестирования.
int computeValue(int input) {
return input * 2;
}
*/
3.3. Javadoc-комментарии (/** */)
Назначение: Используются для документирования кода и генерации профессиональной документации API.
Особенности:
Поддерживают специальные теги (например, @param, @return, @throws) для описания параметров, возвращаемых значений и исключений.
Используются инструментом javadoc для создания HTML-документации.
Обычно размещаются непосредственно перед классами, методами или полями.
#Java #для_новичков #beginner #java_syntax #commentaries
👍2
Пример:
Основные Javadoc-теги:
4. Правильное применение комментариев
Правильное использование комментариев улучшает читаемость, поддерживаемость и качество кода.
Вот рекомендации по их применению:
4.1. Однострочные комментарии
Когда использовать:
Для кратких пояснений к переменным, строкам кода или логике.
Для временных заметок или TODO-комментариев.
Лучшие практики:
Пишите кратко и по делу (например, // Инициализация счетчика).
Избегайте очевидных комментариев (например, // Увеличиваем x на 1 для x++).
Размещайте комментарий на той же строке или над ней, если он поясняет конкретную строку.
Пример:
4.2. Многострочные комментарии
Когда использовать:
Для описания сложной логики или алгоритмов.
Для временного исключения кода при отладке.
Для добавления заметок о контексте или ограничениях.
Лучшие практики:
Используйте для пояснений, которые не помещаются в одну строку.
Избегайте чрезмерного комментирования кода, который можно удалить.
Форматируйте комментарии для читаемости (например, выравнивайте строки).
Пример:
4.3. Javadoc-комментарии
Когда использовать:
Для документирования публичных и защищенных классов, методов и полей.
Для создания документации API, которая будет использоваться другими разработчиками.
Лучшие практики:
Пишите Javadoc для всех публичных элементов API.
Используйте теги (@param, @return) для описания параметров и возвращаемых значений.
Пишите краткие, но полные описания, избегая избыточной информации.
Обновляйте Javadoc при изменении кода.
Пример:
4.4. Общие рекомендации
Самодокументирующийся код: Пишите код так, чтобы он был понятен без комментариев, используя описательные имена переменных и методов.
Избегайте избыточности: Не комментируйте очевидные вещи (например, // Присваиваем 5 для x = 5).
Обновляйте комментарии: Устаревшие комментарии могут ввести в заблуждение.
Используйте TODO и FIXME: Отмечайте незавершенные задачи или проблемы в коде (например, // TODO: Добавить обработку ошибок).
5. Назначение комментариев
Комментарии выполняют несколько ключевых функций:
5.1. Документация кода
Объясняют назначение классов, методов и сложных алгоритмов, делая код понятным для других разработчиков.
5.2. Улучшение читаемости
Поясняют логику, которая может быть неочевидной, особенно в сложных алгоритмах или низкоуровневых операциях.
5.3. Поддержка API
Javadoc-комментарии создают профессиональную документацию, которая используется в библиотеках и фреймворках.
5.4. Отладка и сопровождение
Позволяют временно исключать код или оставлять заметки для будущих изменений.
5.5. Командная работа
Унифицируют понимание кода в команде, особенно в больших или распределенных проектах.
#Java #для_новичков #beginner #java_syntax #commentaries
/**
* Класс для управления данными пользователя.
* @author John Doe
* @version 1.0
*/
public class User {
/**
* Имя пользователя.
*/
private String name;
/**
* Возвращает имя пользователя.
* @return имя пользователя
*/
public String getName() {
return name;
}
}
Основные Javadoc-теги:
@param <имя> <описание>: Описывает параметр метода.
@return <описание>: Описывает возвращаемое значение.
@throws <тип_исключения> <описание>: Указывает исключения, которые может выбросить метод.
@author <имя>: Указывает автора кода.
@version <версия>: Указывает версию класса или метода.
@see <ссылка>: Ссылка на другой класс, метод или ресурс.
4. Правильное применение комментариев
Правильное использование комментариев улучшает читаемость, поддерживаемость и качество кода.
Вот рекомендации по их применению:
4.1. Однострочные комментарии
Когда использовать:
Для кратких пояснений к переменным, строкам кода или логике.
Для временных заметок или TODO-комментариев.
Лучшие практики:
Пишите кратко и по делу (например, // Инициализация счетчика).
Избегайте очевидных комментариев (например, // Увеличиваем x на 1 для x++).
Размещайте комментарий на той же строке или над ней, если он поясняет конкретную строку.
Пример:
int retries = 3; // Максимальное количество попыток подключения
4.2. Многострочные комментарии
Когда использовать:
Для описания сложной логики или алгоритмов.
Для временного исключения кода при отладке.
Для добавления заметок о контексте или ограничениях.
Лучшие практики:
Используйте для пояснений, которые не помещаются в одну строку.
Избегайте чрезмерного комментирования кода, который можно удалить.
Форматируйте комментарии для читаемости (например, выравнивайте строки).
Пример:
/* Алгоритм сортировки пузырьком.
Сравнивает соседние элементы и меняет их местами,
если они находятся в неправильном порядке. */
for (int i = 0; i < array.length - 1; i++) {
for (int j = 0; j < array.length - i - 1; j++) {
// ...
}
}
4.3. Javadoc-комментарии
Когда использовать:
Для документирования публичных и защищенных классов, методов и полей.
Для создания документации API, которая будет использоваться другими разработчиками.
Лучшие практики:
Пишите Javadoc для всех публичных элементов API.
Используйте теги (@param, @return) для описания параметров и возвращаемых значений.
Пишите краткие, но полные описания, избегая избыточной информации.
Обновляйте Javadoc при изменении кода.
Пример:
/**
* Проверяет, является ли число четным.
* @param number Число для проверки
* @return true, если число четное, иначе false
* @throws IllegalArgumentException если число отрицательное
*/
public boolean isEven(int number) {
if (number < 0) {
throw new IllegalArgumentException("Число не может быть отрицательным");
}
return number % 2 == 0;
}
4.4. Общие рекомендации
Самодокументирующийся код: Пишите код так, чтобы он был понятен без комментариев, используя описательные имена переменных и методов.
Избегайте избыточности: Не комментируйте очевидные вещи (например, // Присваиваем 5 для x = 5).
Обновляйте комментарии: Устаревшие комментарии могут ввести в заблуждение.
Используйте TODO и FIXME: Отмечайте незавершенные задачи или проблемы в коде (например, // TODO: Добавить обработку ошибок).
5. Назначение комментариев
Комментарии выполняют несколько ключевых функций:
5.1. Документация кода
Объясняют назначение классов, методов и сложных алгоритмов, делая код понятным для других разработчиков.
5.2. Улучшение читаемости
Поясняют логику, которая может быть неочевидной, особенно в сложных алгоритмах или низкоуровневых операциях.
5.3. Поддержка API
Javadoc-комментарии создают профессиональную документацию, которая используется в библиотеках и фреймворках.
5.4. Отладка и сопровождение
Позволяют временно исключать код или оставлять заметки для будущих изменений.
5.5. Командная работа
Унифицируют понимание кода в команде, особенно в больших или распределенных проектах.
#Java #для_новичков #beginner #java_syntax #commentaries
👍1