コード内のインラインコメントを整列する

インラインコメントの整列

複数のコード行にそれぞれ末尾コメントがある場合、これらのコメントを同じカラムに整列すると、注釈のスキャンがはるかに容易になります。これは設定ファイル、アセンブリ言語、コメントの多いコードブロックで特に有用です。

変換前

port = 8080 # HTTP server port
host = "0.0.0.0" # Bind to all interfaces
workers = 4 # Number of worker processes
timeout = 30 # Request timeout in seconds
max_connections = 1000 # Maximum concurrent connections
debug = false # Enable debug mode

変換後

port            = 8080       # HTTP server port
host            = "0.0.0.0"  # Bind to all interfaces
workers         = 4          # Number of worker processes
timeout         = 30         # Request timeout in seconds
max_connections = 1000       # Maximum concurrent connections
debug           = false      # Enable debug mode

2パスアプローチ

代入とコメントの両方があるコードの整列には、適切な区切り文字での分割が必要です。効果的なアプローチ：

1. 1回目のパス — **Equals =**区切り文字を使用してキーと値を整列します。
2. 2回目のパス — #でCustom区切り文字を使用してコメントマーカーを整列します。

各パスが1セットのカラムを整列し、上記のきれいな結果を生成します。

コメントスタイル

このテクニックはどのコメントマーカーでも機能します：

• # — Python、Ruby、Shell、YAML
• // — JavaScript、TypeScript、C、Go、Rust
• -- — SQL、Lua、Haskell
• ; — アセンブリ、INIファイル

各言語に適切なマーカーをカスタム区切り文字として設定してください。