ホームページ  >  記事  >  バックエンド開発  >  PyCharm でコメントを強調表示するための正規表現

PyCharm でコメントを強調表示するための正規表現

Susan Sarandon
Susan Sarandonオリジナル
2024-11-21 19:22:19857ブラウズ

学生はなぜ正規表現が必要なのかをよく尋ねます。一見すると、その有用性は明らかではないかもしれません。一般に、その目的はテキストを操作すること、つまり検索と置換です。

たとえば、2 つのテスト実行のログを比較する必要があったことがあります。これらは潜在的に同一ですが、各行は異なるタイムスタンプで始まりました。
正規表現を使用してタイムスタンプを照合し、Sublime でこれらの部分文字列を空の文字列に置き換えました (この機能はどのテキスト エディタでも利用できると思われます)。その後、頻繁に使用するファイルとディレクトリを比較するための便利なツールである Meld で 2 つのファイルを比較しました。

PyCharm は、正規表現によるテキストの検索と置換もサポートしています。

Regular Expressions for Highlighting Comments in PyCharm

ただし、正規表現を利用する別の PyCharm 機能、つまりコード内の特定のコメントを強調表示する機能について説明します。最も一般的な例は TODO コメントです。

Regular Expressions for Highlighting Comments in PyCharm

しかし、PyCharm はこのテキストを特定の色で強調表示することをどのようにして知るのでしょうか?これらの設定はカスタマイズできます。それについて詳しく見ていきます。

メニューに移動します:
ファイル ->設定... ->編集者 -> TODO

Regular Expressions for Highlighting Comments in PyCharm

ここには、コメントを強調表示するための 2 つの事前定義ルール、TODO と FIXME があります。試してみてください — FIXME は TODO と同じ強調表示ルールを使用します。
ルール自体は正規表現 btodob.*.

によって定義されます。

このパターンは以下に一致します:

  1. 単語全体としての単語 todo (単語の境界を示すために b を使用)
  2. その後に任意の数の任意の文字 (.*) が続きます。

単語境界 (b) は、w 文字 (文字、数字、またはアンダースコア) と非 w 文字の間のエッジです。

このメニューでは、独自のルールを追加できます。たとえば、「未実装」のルールを追加してみましょう。

Regular Expressions for Highlighting Comments in PyCharm

ここで以下を設定できます:

  • パターン: ハイライトするテキストと一致する正規表現。
  • アイコン: TODO ツールウィンドウに表示されるアイコン。
  • 大文字と小文字の区別: 一致で大文字と小文字が区別されるかどうか。
  • デフォルトのスタイル: チェックされていない場合は、強調表示スタイルをカスタマイズできます。それ以外の場合は、デフォルトの TODO スタイルが適用されます。
  • カスタム スタイル オプション:
    • フォント スタイル (太字、斜体)
    • 文字の色
    • 背景色
    • エラーストライプの色
    • 装飾スタイルとその色 (下線、太字下線、下線、枠線、取り消し線、点線)。

ここで得られるものは次のとおりです:

Regular Expressions for Highlighting Comments in PyCharm

TODO ツール ウィンドウでの表示は次のとおりです。選択したカスタム アイコンが表示され、境界線の色がより目立つようになります。このスクリーンショットでは、フィルター ボタンをクリックして、フィルターがまだ適用されていないことを示しています。

Regular Expressions for Highlighting Comments in PyCharm

TODO 設定に戻り、「未実装」ルールのフィルターを追加しましょう。

Regular Expressions for Highlighting Comments in PyCharm

TODO ツール ウィンドウのリストに新しい「未実装」フィルターが表示されます。このフィルターを選択すると、「未実装」コメントのみが TODO ツール ウィンドウに表示されます。

Regular Expressions for Highlighting Comments in PyCharm

TODO コメント設定には、まだ触れていないオプションがもう 1 つあります。「次の行のインデントされたテキストを同じ TODO の一部として扱う」です。

このチェックボックスはすべてのルールに適用されます。 TODO コメントに続く行にインデントされたコメントが含まれている場合、同じルールが適用されます。

Regular Expressions for Highlighting Comments in PyCharm


ご覧のとおり、過度に複雑な正規表現を作成する必要はありません。単純なもので十分です。ただし、このような状況であっても、作業を容易にすることができます。
正規表現をよく使用しますか?

以上がPyCharm でコメントを強調表示するための正規表現の詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。

声明:
この記事の内容はネチズンが自主的に寄稿したものであり、著作権は原著者に帰属します。このサイトは、それに相当する法的責任を負いません。盗作または侵害の疑いのあるコンテンツを見つけた場合は、admin@php.cn までご連絡ください。