### 使用 Puppet 社區規范 > A society made up of individuals who were all capable of original thought would probably be unendurable. > > — H. L. Mencken “隨大溜” 有時會是個好主意。如果其他人需要閱讀或管理你的配置清單， 或者如果你想要分享代碼到社區， 那么盡可能遵循現有的樣式約定會是個好主意。 #### 操作步驟 1. 將你的資源名用雙引號括起來；例如使用 package { "exim4": 而不是 package { exim4: 當使用一些像連字符和空格這樣的字符時很容易引起 Puppet 解析器的混亂， 明智而又安全的做法是始終使用雙引號將所有的資源名括起來。 2. 總是將非 Puppet 保留字的參數值用雙引號括起來，例如： ``` name => "Nucky Thompson", mode => "0700", owner => "deploy", ``` 但保留字不用使用引號： ``` ensure => installed, enable => true, ensure => running, ``` 當在字符串中引用變量的值時，始終使用大括號將變量名括起來。例如： ``` source => "puppet:///modules/webserver/${brand}.conf", ``` 否則 Puppet 的解析器不得不猜測哪些字符是變量名的一部分。使用大括號將使其變得清晰。 3. 總是以逗號結束參數聲明的行，即使它是最后一個參數： ``` service { "memcached": ensure => running, enable => true, } ``` 很多時候，當你編輯文件時會追加一個額外的參數， 而忘記在原來最后一行的末尾添加必要的逗號！ 4. 當聲明僅有一個參數的資源時，將聲明放在一行上且無需使用結尾的逗號： ``` package { "puppet": ensure => installed } ``` 5. 當聲明有多個參數的資源時，每個參數占一行： ``` package { "rake": ensure => installed, provider => gem, require => Package["rubygems"], } ``` 6. 當聲明 **符號鏈接**（**symlinks**）時，使用 ensure => link： ``` file { "/etc/php5/cli/php.ini": ensure => link, target => "/etc/php.ini", } ``` 7. 為了使代碼便于閱讀，所有的箭頭以最長一個參數對齊，例如： ``` file { "/var/www/${app}/shared/config/rvmrc": owner => "deploy", group => "deploy", content => template("rails/rvmrc"), require => File["/var/www/${app}/shared/config"], } ``` 每個資源中的箭頭（=>）都要對齊，而不是每個文件中的箭頭都對齊； 否則會在不同文件之間復制代碼時帶來麻煩。 #### 更多用法 Puppet Labs 網站上維護著 Puppet 社區規范指南文檔： [http://docs.puppetlabs.com/guides/style_guide.html](http://docs.puppetlabs.com/guides/style_guide.html) 。 Tim Sharpe 寫了一個 puppet-lint 工具， 你可以用它檢查你的配置清單是否符合規范。 運行 gem install puppet-lint 安裝它，詳細的信息請參考 [https://github.com/rodjek/puppet-lint](https://github.com/rodjek/puppet-lint) 。