TechNet マガジン Oct. 2011のPowerShell記事(コード整形)に対する意見 - PowerShell Scripting Weblog

2011/11/14

TechNet マガジン October 2011内のWindows PowerShell: 空白文字を入れてくださいという記事に対する意見です。

PowerShellスクリプトを記述するときは適宜空白文字やインデントを入れて見やすくしましょう、という趣旨の記事なんですが、その趣旨には同意するものの、どうも実際にインデントを入れたスクリプトの例がいけてない気がしました。

ここでインデントや改行などを適切に追加して体裁を整えたとされるコードは次のようなものです。

(ブログのスタイルに起因する見え方の違いが考えられるので、比較のためにオリジナルも再掲させていただきます)

function Get-PCInfo {
[CmdletBinding()]
param(
        [Parameter(Mandatory=$True,
ValueFromPipeline=$True,
ValueFromPipelineByPropertyName=$True)]
        [string[]]$computername
    )
    PROCESS {
        Write-Verbose "Beginning PROCESS block"
foreach ($computer in $computername) {
            Write-Verbose "Connecting to $computer"
            try {
                $continue = $true
                $cs = Get-WmiObject -EV mybad -EA Stop `
-Class Win32_computersystem `
-ComputerName $computer
            } catch {
                $continue = $false
                $computer | 
Out-File -FilePath oops.txt -append
Write-Verbose "$computer failed"
                $mybad | ForEach-Object { Write-Verbose $_ }
            }
            if ($continue) {
                $proc = Get-WmiObject win32_processor `
-ComputerName $computer | 
                    select -first 1
                $obj = new-object -TypeName PSObject
             $obj | add-member NoteProperty ComputerName $computer
             $obj | add-member NoteProperty ProcArchitecture $proc.addresswidth
             $obj | add-member NoteProperty Domain $cs.domain
             $obj | add-member NoteProperty PCModel $cs.model
                $obj.psobject.typenames.insert(0,'MyPCInfo')
                write-output $obj
            }
        }
    }
}

最初見た時、全体的に何がなんだか分からなかったのですが、よくよく見てみると一応ルールはあるようで、一つの文を改行して複数行に記述する場合は、二行目以降は文頭から詰めて記述する、というルールに従っているようです。

こういう書き方はかえって読みづらいと感じてしまうのは私だけでしょうか? 確かに、Webページや書籍などで一行がスペースに収まらないときに強制的に改行して表示する場合にこのような体裁になることはありますが、これははっきり言って読みづらいです。

せっかく自分で改行を入れるわけですから、改行したときも読みやすくしたほうがいいでしょう(そもそも強制改行されて読みづらくなるというのを防ぐというのも、自分で改行を入れる意義の一つなわけですから)。

あとparam()やforeach{}のインデント位置はそもそもなぜそうなのかよくわかりませんね(単なる編集ミスだろうか?)。

この辺を踏まえて、私流にインデントを入れるとこんな感じです。

function Get-PCInfo
{
    [CmdletBinding()]
    param
    (
        [Parameter(
            Mandatory=$True,
            ValueFromPipeline=$True,
            ValueFromPipelineByPropertyName=$True
        )]
        [string[]]$computername
    )
    
    process
    {
        Write-Verbose "Beginning PROCESS block"
        foreach ($computer in $computername)
        {
            Write-Verbose "Connecting to $computer"
            try 
            {
                $continue = $true
                $cs = Get-WmiObject -EV mybad -EA Stop `
                      -Class Win32_computersystem -ComputerName $computer
            }
            catch
            {
                $continue = $false
                $computer | 
                    Out-File -FilePath oops.txt -append
                Write-Verbose "$computer failed"
                $mybad | ForEach-Object { Write-Verbose $_ }
            }
            if ($continue)
            {
                $proc = Get-WmiObject win32_processor `
                        -ComputerName $computer |
                            select -first 1
                $obj = new-object -TypeName PSObject
                $obj | add-member NoteProperty ComputerName $computer
                $obj | add-member NoteProperty ProcArchitecture $proc.addresswidth
                $obj | add-member NoteProperty Domain $cs.domain
                $obj | add-member NoteProperty PCModel $cs.model
                $obj.psobject.typenames.insert(0,'MyPCInfo')
                write-output $obj
            }
        }
    }
}

こんな感じでPowerShellも基本的には他の言語のコード整形の流儀に準じればいいと思います。唯一PowerShellで特徴的なのは複数行に渡るパイプラインの記述方法になると思いますが、そこも特に深く考えずに一段インデントを深くする程度でいいのではないかと思います。

あと「一貫性」の節で、「{」を改行の前に入れるか後に入れるかは統一させよとありますが、基本的にはそれでいいと思います。ただ改行の後に「{」を入れるスタイル(私の書いた例)でも、改行後に「{」や「(」を入れるとコードの意味が変わったりエラーになったりする場合が出てくるので、その場合はわざわざ継続文字「`」を入れてやらずとも、その部分だけは改行前に入れてやってもいいかなと思います。

具体的にはこのコードでいうと「[Parameter( 」のところなどですね。あとスクリプトブロックをパラメータに取るコマンドレットの場合なんかもそうです。

@(1..12)|ForEach-Object {
    Write-Host $_
    Write-Host ($_ * $_)
}

こういうのですね。この場合ForEach-Objectコマンドレットの-processパラメータ(ここではパラメータ名は省略されている)にスクリプトブロックを指定しているのですが、「{」はスクリプトブロックリテラルの開始文字なので、改行後に入れると正しく動作しません。

PowerShell ISEはまだVisual Studioなどに比べると編集機能が貧弱で、構文を元に自動的に整形してくれたりしないので、ユーザーが自分ルールで整形していかないといけないです。しかし基本的には他の言語と同様な、素直な整形を施してやれば特に読みづらくなるということもないかなと思います。

元記事:http://blogs.wankuma.com/mutaguchi/archive/2011/11/14/212009.aspx

トラックバック

トラックバックはまだありません

トラックバックPing:


コメント

コメントはまだありません


コメントをどうぞ

名前 (省略可) :
E-mail or URL (省略可) :


前の記事へ | 次の記事へ

Copyright © 2005-2016 Daisuke Mutaguchi All rights reserved

mailto: mutaguchi at roy.hi-ho.ne.jp

Awards

Books

Twitter