Limpiar tu código eliminando las anotaciones innecesarias 
 
 TL;DR: Haz que tu código sea más sencillo y más mantenible al eliminar las anotaciones redundantes o no utilizadas. TL;DR: Haz que tu código sea más sencillo y más mantenible al eliminar las anotaciones redundantes o no utilizadas. Problemas solucionados 
 
 
 
 
 
 
 
 
 
 Comentarios obsoletos Código confuso Disminución de la legibilidad Mantenimiento Overhead Metadatos innecesarios Soluciones Overengineered Metaprogramación Decisiones de diseño ocultas Dos Código relacionado Olor 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 Pasos 
 
 
 
 
 Identificar las anotaciones que hinchan su código. Evaluar su finalidad y necesidad. Eliminar las anotaciones sin valor claro. Reemplazar las anotaciones críticas con código explícito. Código de muestreo Antes de <?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");
    }
}
 Después de 🙂 <?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
    }
}
 Tipo 
 
 semiautomático Puedes reescribirlos con expresiones o con un asistente de IA. Seguridad ️ Puede eliminar de forma segura las anotaciones si son puramente metadatos o documentación, pero asegúrese de que las anotaciones funcionales (como @Deprecated) se sustituyan por código explícito o lógica para mantener el comportamiento. ¿Por qué el código es mejor? Obtén un código más limpio, más fácil de leer y menos confuso. Eliminar las anotaciones innecesarias reduce la carga de mantenimiento y se centra en la lógica central. El código explícito sobre las anotaciones mejora la claridad y reduce la dependencia de metadatos que pueden estar obsoletos. ¿Cómo mejorar la bijeción? ️ Simplifica el mapeo entre los El problema y el código mediante la eliminación de anotaciones que no modelan el dominio. El mundo real Esto hace que sea más claro, Correspondencia con el espacio del problema, reducción del ruido y mejora del mantenimiento. Uno a uno Limitaciones ☀️ Algunas anotaciones son críticos para la funcionalidad en ciertos marcos. (por ejemplo, @Override, @Transactional) Debe evaluar cuidadosamente el papel de cada anotación antes de la eliminación para evitar el comportamiento quebrantador. Refactor con AI Puedes usar herramientas de IA como ChatGPT o GitHub Copilot para analizar tu base de código. Pídale a la IA que identifique las anotaciones, explique su propósito y sugiera sustituciones con código explícito. 
 
 Prompt sugerido: 1. identifica las anotaciones que inundan tu código.2. evalúa su propósito y necesidad.3. elimina las anotaciones sin valor claro.4. reemplaza las anotaciones críticas con código explícito. Prompt sugerido: 1. identifica las anotaciones que inundan tu código.2. evalúa su propósito y necesidad.3. elimina las anotaciones sin valor claro.4. reemplaza las anotaciones críticas con código explícito. 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 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 Perplejidad Perplejidad piloto piloto tú tú Gemini Gemini profundidad profundidad El objetivo es El objetivo es Grúas Grúas Quien Quien Tags ️ 
 
 Comentarios Nivel 
 
 [x] El Intermedio Reacciones relacionadas https://hackernoon.com/improving-the-code-one-line-at-a-time?embedable=true https://maximilianocontieri.com/refactoring-011-replace-comments-with-tests?embedable=true Créditos Imagen por es Diseño de congresos Pixabay Este artículo forma parte de la serie 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

Este audio es producido en el idioma original de la historia!

Demasiado Largo; Para Leer

Refactoring 033 - Eliminar anotaciones redundantes o no utilizadas

Refactoring 033 - Eliminar anotaciones redundantes o no utilizadas

About Author

COMENTARIOS

ETIQUETAS

ESTE ARTÍCULO FUE PRESENTADO EN

Related Stories

¿Quieres ganar un concurso de redacción de HackerNoon? Esto es lo que recomiendan los ganadores del concurso #crypto-api

Valhalla de Floki se une como patrocinador asociado de la gira de la India por Sri Lanka

Toque para ganar: Telegram puede incorporar a los próximos 10 mil millones de usuarios de criptomonedas antes de Solana

Las capas invisibles: por qué las entrevistas con los usuarios son un activo irremplazable

¿Quieres ganar un concurso de redacción de HackerNoon? Esto es lo que recomiendan los ganadores del concurso #crypto-api

Valhalla de Floki se une como patrocinador asociado de la gira de la India por Sri Lanka

Toque para ganar: Telegram puede incorporar a los próximos 10 mil millones de usuarios de criptomonedas antes de Solana

Las capas invisibles: por qué las entrevistas con los usuarios son un activo irremplazable

Light-Mode

Classic

Newspaper

Dark-Mode

Neon Noir

Minty

HN StartUps