Reinigen Sie Ihren Code, indem Sie unnötige Anmerkungen entfernen 
 
 TL;DR: Machen Sie Ihren Code einfacher und wartungsfähiger, indem Sie redundante oder ungenutzte Anmerkungen entfernen. TL;DR: Machen Sie Ihren Code einfacher und wartungsfähiger, indem Sie redundante oder ungenutzte Anmerkungen entfernen. Probleme gelöst 
 
 
 
 
 
 
 
 
 
 Veraltete Kommentare Verwirrter Code Niedrigere Lesbarkeit Überhead Wartung Unnötige Metadaten Überschaubare Lösungen Metaprogrammierung Versteckte Designentscheidungen Zwei Verwandte Codes riechen 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 Schritte 
 
 
 
 
 Identifizieren Sie Anmerkungen, die Ihren Code aufblasen. Bewerten Sie ihren Zweck und ihre Notwendigkeit. Entfernen Sie Anmerkungen ohne klaren Wert. Ersetzen Sie kritische Anmerkungen durch expliziten Code. Sample Code vor <?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");
    }
}
 Nach dem 🙂 <?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
    }
}
 Typ 
 
 halbautomatisch Sie können sie mit Ausdrücken oder mit einem KI-Assistent neu schreiben. Sicherheit ️ Sie können Anmerkungen sicher entfernen, wenn sie reine Metadaten oder Dokumentation sind, aber stellen Sie sicher, dass alle funktionalen Anmerkungen (wie @Deprecated) durch expliziten Code oder Logik ersetzt werden, um das Verhalten aufrechtzuerhalten. Warum ist der Code besser? Sie erhalten sauberen, leichter lesbaren und weniger verwirrten Code. Das Entfernen unnötiger Anmerkungen reduziert die Wartungsüberschüsse und konzentriert sich auf die Kernlogik. Ausdrücklicher Code über Anmerkungen verbessert die Klarheit und reduziert die Abhängigkeit von Metadaten, die möglicherweise veraltet werden. Wie verbessert es die Bijection? ️ Sie vereinfachen die Mapping zwischen den Problem und Code durch Entfernen von Anmerkungen, die die Domäne nicht modellieren. Reale Welt Dies erzeugt eine klarere, Übereinstimmung mit dem Problemraum, Reduzierung von Lärm und Verbesserung der Wartungsfähigkeit. Ein-zu-einem Einschränkungen ️ Einige Anmerkungen Sie sind für die Funktionalität in bestimmten Frames von entscheidender Bedeutung. (z.B. @Override und @Transactional) Sie müssen die Rolle jeder Annotation vor dem Entfernen sorgfältig bewerten, um brechendes Verhalten zu vermeiden. Refactor mit AI Sie können KI-Tools wie ChatGPT oder GitHub Copilot verwenden, um Ihre Codebase zu analysieren. Bitten Sie die KI, Anmerkungen zu identifizieren, ihren Zweck zu erklären und Ersetzungen mit explizitem Code vorzuschlagen. 
 
 1. Identifizieren Sie Anmerkungen, die Ihren Code aufblasen.2. Bewerten Sie deren Zweck und Notwendigkeit.3. Entfernen Sie Anmerkungen ohne eindeutigen Wert.4. Ersetzen Sie kritische Anmerkungen durch expliziten Code. 1. Identifizieren Sie Anmerkungen, die Ihren Code aufblasen.2. Bewerten Sie deren Zweck und Notwendigkeit.3. Entfernen Sie Anmerkungen ohne eindeutigen Wert.4. Ersetzen Sie kritische Anmerkungen durch expliziten Code. 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 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 ChatGPT ChatGPT Claude Claude Verwirrung Verwirrung Kinderpilot Kinderpilot Du bist Du bist Gemini Gemini DeepSeek DeepSeek Ziel ist AI Ziel ist AI Groke Groke QWEN QWEN Tags ️ 
 
 Kommentare Ebene 
 
 [x] Zwischenzeit Verwandte Reaktionen https://hackernoon.com/improving-the-code-one-line-at-a-time?embedable=true https://maximilianocontieri.com/refactoring-011-replace-comments-with-tests?embedable=true Kredite Bild von ist Kongressdesign von Pixabay Dieser Artikel ist Teil der Refactoring-Serie. 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

Dieses Audio ist in der Originalsprache der Geschichte produziert!

Zu lang; Lesen

Refactoring 033 - Entfernen von redundanten oder ungenutzten Annotationen

Refactoring 033 - Entfernen von redundanten oder ungenutzten Annotationen

About Author

KOMMENTARE

Hängeetiketten

DIESER ARTIKEL WURDE VORGESTELLT IN

Related Stories

HackerNoon Decoded 2024: Celebrating Our Writing Community!

Genuine Content Creation in the Age of AI: Why Startups Need Quality Content

HackerNoon Decoded 2024: Celebrating Our Cybersecurity Community!

HackerNoon Decoded 2024: Celebrating Our Writing Community!

Genuine Content Creation in the Age of AI: Why Startups Need Quality Content

HackerNoon Decoded 2024: Celebrating Our Cybersecurity Community!

Light-Mode

Classic

Newspaper

Dark-Mode

Neon Noir

Minty

HN StartUps