Vyčistite svoj kód odstránením zbytočných poznámok 
 
 TL;DR: Urobte svoj kód jednoduchší a udržateľnejší odstránením redundantných alebo nepoužitých poznámok. TL;DR: Urobte svoj kód jednoduchší a udržateľnejší odstránením redundantných alebo nepoužitých poznámok. Problémy riešené 
 
 
 
 
 
 
 
 
 
 zastarané komentáre Zlomený kód Nižšia čitateľnosť Údržba nad hlavou zbytočné metastázy Overengineered riešenia Metaprogramovanie Skryté dizajnové rozhodnutia Dvojka Súvisiaci kód Vôňa 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 Kroky 
 
 
 
 
 Identifikujte poznámky, ktoré nafukujú váš kód. Vyhodnoťte ich účel a potrebu. Odstráňte poznámky bez jasnej hodnoty. Nahraďte kritické poznámky explicitným kódom. Vzorový kód pred <?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");
    }
}
 Po tomto <?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 
 
 poloautomatické Môžete ich prepísať pomocou výrazov alebo pomocou asistenta AI. Bezpečnosť ️ Môžete bezpečne odstrániť poznámky, ak sú čisto metaúdaje alebo dokumentácie, ale uistite sa, že akékoľvek funkčné poznámky (napríklad @Deprecated) sú nahradené explicitným kódom alebo logikou na udržanie správania. Prečo je tento kód lepší? Získate čistejší, ľahšie čitateľný a menej neporiadny kód. Odstránenie zbytočných poznámok znižuje údržbu a zameriava sa na základnú logiku. Explicitný kód nad poznámkami zlepšuje jasnosť a znižuje závislosť od metaúdajov, ktoré môžu byť zastarané. Ako si vylepšiť náladu? ️ Zjednodušuje sa mapovanie medzi problém a kód odstránením poznámok, ktoré nie sú modelom domény. reálny svet To vytvára jasnejšie, zhodu s problémovým priestorom, zníženie hluku a zlepšenie udržateľnosti. Jeden na jedného Obmedzenia ️ Niektoré poznámky sú nevyhnutné pre funkčnosť v určitých rámcoch. (napríklad @Override, @Transactional) Pred odstránením musíte starostlivo vyhodnotiť úlohu každej poznámky, aby ste predišli porušovaniu správania. Reaktor s AI Môžete použiť AI nástroje ako ChatGPT alebo GitHub Copilot na analýzu vašej kódovej základne. Požiadajte AI, aby identifikovala poznámky, vysvetlila ich účel a navrhla náhrady explicitným kódom. 
 
 Navrhovaná príručka: 1. identifikujte poznámky, ktoré nadýchajú váš kód.2. zhodnoťte ich účel a nevyhnutnosť.3. odstráňte poznámky bez jasnej hodnoty.4. nahraďte kritické poznámky explicitným kódom. Navrhovaná príručka: 1. identifikujte poznámky, ktoré nadýchajú váš kód.2. zhodnoťte ich účel a nevyhnutnosť.3. odstráňte poznámky bez jasnej hodnoty.4. nahraďte kritické poznámky explicitným kódom. 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 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 Chatky Chatky Claude sa Claude sa Perplexita Perplexita detský pilot detský pilot Ty si Ty si Dvojčatá Dvojčatá hĺbka hĺbka Cieľ AI Cieľ AI Grochová Grochová kvitnúť kvitnúť Týždeň ️ 
 
 komentáre Úroveň 
 
 [x] Priemerná Súvisiace replikácie https://hackernoon.com/improving-the-code-one-line-at-a-time?embedable=true https://maximilianocontieri.com/refactoring-011-replace-comments-with-tests?embedable=true Pôžičky 🙂 Obrázok od je Kongresový dizajn Pixabay → Tento článok je súčasťou série 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

Tento zvuk je vyrobený v pôvodnom jazyku príbehu!

Príliš dlho; Čítať

Refactoring 033 - Odstránenie redundantných alebo nepoužitých poznámok

Refactoring 033 - Odstránenie redundantných alebo nepoužitých poznámok

About Author

KOMENTÁRE

ZAVISTE ŠTÍTKY

TENTO ČLÁNOK BOL PREDSTAVENÝ V

Related Stories

16 Best Sklearn Datasets for Building Machine Learning Models

112 Stories To Learn About Hackernoon Community

THE CRAB-SPIDER

16 Best Sklearn Datasets for Building Machine Learning Models

112 Stories To Learn About Hackernoon Community

THE CRAB-SPIDER

Light-Mode

Classic

Newspaper

Dark-Mode

Neon Noir

Minty

HN StartUps