コード規約

どうもデファクトなコード規約が見付からないので, あくまで自分用に整備しておく.

スクリプトファイル名

規定事項

  • 拡張子は ps1

独自の規約

  • snake_case

C:\Users\Hoge> powershell.exe .\some_useful_script.ps1

変数名

規定事項

  • $ で始まる
  • 英数字かアンダースコア

独自の規約

  • lowerCamelCase

    大文字小文字の区別はされないが, コードの見た目のため

  • 基本的には Set-Variable は使わない. (長くて見づらくなるし, 特に必要無いはず)

$someVariable = 1
Echo $someVariable # => 1

定数名

定数は変数の一種らしい

規定事項

  • 変数の一種なので $ から始まる.
  • Set-Variable cmdlet のオプションで -Option constant とやると作成できる
  • 代入しようとするとエラーが出る

独自の規約

  • UpperCamelCase

    こうしておくと可変 (mutable) な普通の変数との区別が付く

# 定義するときは ``$`` は付けなくて良い
Set-Variable -Name NeverChanged -Value "I am immutable!" -Option constant
Echo $NeverChanged # => I am immutable!

$NeverChanged = "If I could be mutable,..."
変数 NeverChanged は読み取り専用または定数であるため、上書きできません。
発生場所 行:1 文字:14
+ $NeverChanged <<<<  = "If I could be mutable,..."
    + CategoryInfo          : WriteError: (NeverChanged:String) []、SessionStateUnauthorizedAccessException
    + FullyQualifiedErrorId : VariableNotWritable

インデント

  • 基本的には, 空白 (0x20) 2 つ

    もしかしたら変えるかも