Очистите свой код, удалив ненужные аннотации 
 
 TL;DR: Сделайте свой код более простым и удобным для поддержания, удаляя избыточные или неиспользованные аннотации. TL;DR: Сделайте свой код более простым и удобным для поддержания, удаляя избыточные или неиспользованные аннотации. Решенные проблемы 
 
 
 
 
 
 
 
 
 
 устаревшие комментарии Смешанный код Низкая читаемость Поддержание над головой Ненужные метаданные Сверхинженерные решения Метапрограммирование Скрытые дизайнерские решения Двух Оригинальное название: Code Smells https://hackernoon.com/how-to-find-the-stinky-parts-of-your-code-part-xxxi https://hackernoon.com/how-to-find-the-stinky-parts-of-your-code-part-xxxvii https://hackernoon.com/how-to-find-the-stinky-parts-of-your-code-part-xxxi https://hackernoon.com/how-to-find-the-stinky-parts-of-your-code-part-xxx https://hackernoon.com/how-to-find-the-stinky-parts-of-your-code-part-i-xqz3evd https://hackernoon.com/how-to-find-the-stinky-parts-of-your-code-part-xxxiv https://hackernoon.com/how-to-find-the-stinky-parts-of-your-code-part-xxx Шаги 
 
 
 
 
 Идентифицируйте заметки, которые раздувают ваш код. Оцените их цель и необходимость. Удаляйте аннотации без четкого значения. Замените критические заметки ясным кодом. Образец кода Перед <?php
// @author John Wick
// @version 3.14
// @description Service for user operations
class UserService {
    /**
     * @deprecated
     * @param int $id
     * @return string
     */
    public function userName($id) {
        // @todo Sanitize input
        return $this->database->query(
            "SELECT name FROM users WHERE id = $id");
    }
}
 После <?php
class UserService {
    // Step 1: Identified annotations 
    //   (@author, @version, @description, 
    // Step 2: Evaluated their purpose 
    //   (metadata, deprecated, todo notes)
    // Step 3: Removed unnecessary annotations (no value added)
    // Step 4: Replaced critical annotations 
    //   with explicit code (none needed)
  
    // Type hintings are explicit
    public function userName(int $id): string {        
        $statement = $this->database->prepare(
          "SELECT name FROM users WHERE id = ?");
        // No tech debt 
        $statement->execute([$id]);
        return $statement->fetchColumn();
        // You can add a test to ensure there are 
        // no new calls to this deprecated method
    }
}
 Тип 
 
 Полуавтоматический Вы можете переписать их с помощью выражений или с помощью помощника ИИ. Безопасность ️ Вы можете безопасно удалять аннотации, если они являются чисто метаданными или документацией, но убедитесь, что любые функциональные аннотации (например, @Deprecated) заменены явным кодом или логикой для поддержания поведения. Почему код лучше? Вы получаете более чистый, легкий для чтения и менее запутанный код. Удаление ненужных аннотаций уменьшает нагрузку на техническое обслуживание и фокусируется на основной логике. Ясный код над заметками улучшает четкость и уменьшает зависимость от метаданных, которые могут стать устаревшими. Как улучшить состояние? ️ Вы упрощаете картографирование между проблема и код, удаляя аннотации, которые не моделируют домен. Реальный мир Это создает более ясный, соответствие с проблемным пространством, снижение шума и улучшение технического обслуживания. Один на один Ограничения ☀️ Некоторые аннотации Они имеют решающее значение для функциональности в определенных рамках. (например, @Override, @Transactional) Вы должны тщательно оценить роль каждой аннотации перед удалением, чтобы избежать нарушающего поведения. Реактор с AI Вы можете использовать инструменты ИИ, такие как ChatGPT или GitHub Copilot, чтобы проанализировать вашу кодовую базу. Попросите ИИ идентифицировать аннотации, объяснить их цель и предложить замены с явным кодом. 
 
 Предложенная пометка: 1.Идентифицируйте аннотации, надувающие ваш код.2.Оцените их предназначение и необходимость.3.Удалите аннотации без четкого значения.4.Замените критические аннотации явным кодом. Предложенная пометка: 1.Идентифицируйте аннотации, надувающие ваш код.2.Оцените их предназначение и необходимость.3.Удалите аннотации без четкого значения.4.Замените критические аннотации явным кодом. 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 Without Proper Instructions 
 With Specific Instructions 
 
 
 
 ChatGPT 
 ChatGPT 
 
 
 
 Claude 
 Claude 
 
 
 
 Perplexity 
 Perplexity 
 
 
 
 Copilot 
 Copilot 
 
 
 
 You 
 You 
 
 
 
 Gemini 
 Gemini 
 
 
 
 DeepSeek 
 DeepSeek 
 
 
 
 Meta AI 
 Meta AI 
 
 
 
 Grok 
 Grok 
 
 
 
 Qwen 
 Qwen ЧатГП ЧатГП Клод Клод Перспективность Перспективность Пилот Пилот Ты Ты Близнецы Близнецы DeepSeek DeepSeek Цель AI Цель AI ГРОК ГРОК Квен Квен Теги ️ 
 
 Комментарии Уровень 
 
 [x] Посредник Связанные рефлексы https://hackernoon.com/improving-the-code-one-line-at-a-time?embedable=true https://maximilianocontieri.com/refactoring-011-replace-comments-with-tests?embedable=true Кредиты Изображение от Он Конгрессдизайн Pixabay Эта статья является частью серии Refactoring. https://maximilianocontieri.com/how-to-improve-your-code-with-easy-refactorings?embedable=true

Winner of Noonies 2020 for the award Hacker Noon Contributor of the Year - REFACTORING.

2020 - Hacker Noon Contributor of the Year in REFACTORING

2022 - HackerNoon Contributor of the Year - Clean Code

2022 - HackerNoon Contributor of the Year - Debugging

2022 - HackerNoon Contributor of the Year - Github

2022 - HackerNoon Contributor of the Year - Machine Learning

2022 - HackerNoon Contributor of the Year - Quality Assurance

2022 - HackerNoon Contributor of the Year - Refactoring

2022 - HackerNoon Contributor of the Year - Software Architecture

2022 - the Greatest Storyteller

Buy My Book

Share your ideas with me!

Read My Stories

Buy Me a Coffee

Software Engineer and Book Author

Этот звук создан на языке оригинала истории!

Слишком долго; Читать

033 - Удаление излишних или неиспользованных аннотаций

033 - Удаление излишних или неиспользованных аннотаций

About Author

КОММЕНТАРИИ

БИРКИ

ЭТА СТАТЬЯ БЫЛА ПРЕДСТАВЛЕНА В

Related Stories

Полное руководство по успешной миграции в облако: стратегии и лучшие практики

От форумов до лент новостей: как алгоритмы социальных сетей формируют цифровое взаимодействие

Хотите выиграть конкурс HackerNoon? Вот что рекомендуют победители конкурса #crypto-api

Полное руководство по успешной миграции в облако: стратегии и лучшие практики

От форумов до лент новостей: как алгоритмы социальных сетей формируют цифровое взаимодействие

Хотите выиграть конкурс HackerNoon? Вот что рекомендуют победители конкурса #crypto-api

Light-Mode

Classic

Newspaper

Dark-Mode

Neon Noir

Minty

HN StartUps