不要なノートを削除してコードをクリアする 
 
 TL;DR:余剰または未使用の注記を削除することで、コードを単純化し、より維持可能にします。 TL;DR:余剰または未使用の注記を削除することで、コードを単純化し、より維持可能にします。 問題解決 ↓↓ 
 
 
 
 
 
 
 
 
 
 時代遅れのコメント バラバラコード 読みやすさの低下 Overhead メンテナンス 不要なメタデータ Overengineeredソリューション メタプログラミング 隠されたデザイン決定 2位 関連コード 臭い 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
    }
}
 タイプ↓ 
 
 半自動 表現やAIアシスタントで書き換えることができます。 セキュリティ ️ 純粋にメタデータまたはドキュメントである場合は、注釈を安全に削除できますが、機能的な注釈( @Deprecated など)が明示的なコードまたは論理で置き換えられて行動を維持するようにしてください。 なぜコードが良いのか? あなたは、よりクリーンで、読みやすく、そして混乱したコードが少なくなります。 不要な注釈を削除すると、メンテナンス上の負担を減らし、コアの論理に焦点を当てることができます。 注記の上で明確なコードは、明確性を向上させ、時代遅れになる可能性のあるメタデータへの依存を減らす。 では、どのようにしてバリエーションを改善するのか?️ You simplify the mapping between the 問題とコードは、ドメインをモデル化しない注釈を削除することによって起こります。 現実世界 より明確に創造される。 問題空間と一致し、騒音を減らし、保守性を向上させます。 ひとつひとつ ️制限 いくつかの注釈 いくつかのフレームワークにおける機能性に不可欠です。 (例えば、 @Override、 @Transactional) 削除する前に各注釈の役割を慎重に評価する必要があります。 Refactor with AI ChatGPT や GitHub Copilot などの AI ツールを使用してコードベースを分析できます。 AI に注釈を識別し、その目的を説明し、明示的なコードで置き換えを提案してください。 
 
 Suggested Prompt: 1. Identify annotations bloating your code. 2. Evaluate their purpose and necessity. 3. Remove annotations with no clear value. 4. Replace critical annotations with explicit code. コードの必要性と目的を評価する。 Suggested Prompt: 1. Identify annotations bloating your code. 2. Evaluate their purpose and necessity. 3. Remove annotations with no clear value. 4. Replace critical annotations with explicit 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 チャット チャット クラウド クラウド 戸惑い 戸惑い パイロット パイロット あなた あなた 双子 双子 ディープ検索 ディープ検索 ターゲット AI ターゲット AI グロック グロック QWEN QWEN タグ ️ 
 
 コメント レベル 
 
 (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 クレジット↓ 画像 by は コンゴデザイン ピクセイ この記事は、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

このオーディオは、ストーリーの元の言語で制作されています。

長すぎる; 読むには

Refactoring 033 - Removing Redundant or Unused Annotations (リサイクル)

Refactoring 033 - Removing Redundant or Unused Annotations (リサイクル)

About Author

コメント

ラベル

この記事は

Related Stories

HackerNoon ライティングコンテストで優勝したいですか? #crypto-api コンテスト優勝者のおすすめはこちら

デジタルノマドの皆さん、タイの新しい DTV ビザについて知っておくべきこと

Telegram: クリプト島と本土を結ぶ橋

HackerNoon Coded: HackerNoonが最も活発に活動している上位10カ国

HackerNoon ライティングコンテストで優勝したいですか? #crypto-api コンテスト優勝者のおすすめはこちら

デジタルノマドの皆さん、タイの新しい DTV ビザについて知っておくべきこと

Telegram: クリプト島と本土を結ぶ橋

HackerNoon Coded: HackerNoonが最も活発に活動している上位10カ国

Light-Mode

Classic

Newspaper

Minty

Dark-Mode

Neon Noir

Minty

HN StartUps