php - 嗅探器代码段允许在新行上使用括号

Question

是否有一个 codesniffer 片段允许/强制将 { } 放在每个函数/方法的换行符上？

基本上，强制这样的事情:

if (TRUE)
{
     // Code logic
}
else
{
    // Code Logic
}

和

public function test()
{
     // Code logic
}

Answer 1

是的，有现成的。它称为 OpeningFunctionBraceBsdAllmanSniff，您可以在 /path/to/CodeSniffer/Standards/Generic/Sniffs/Functions 下找到它。但这仅适用于函数声明。

对于控制结构，您可以使用 /path/to/Standards/Squiz/Sniffs/ControlStructures/ControlSignatureSniff.php 并调整来自

的模式数组

protected function getPatterns()
{
    return array(
            'try {EOL...} catch (...) {EOL',
            'do {EOL...} while (...);EOL',
            'while (...) {EOL',
            'for (...) {EOL',
            'if (...) {EOL',
            'foreach (...) {EOL',
            '} else if (...) {EOL',
            '} elseif (...) {EOL',
            '} else {EOL',
           );

}//end getPatterns()

到，即

protected function getPatterns()
{
    return array(
            'try {EOL...} catch (...) {EOL',
            'do {EOL...} while (...);EOL',
            'while (...) {EOL',
            'for (...) {EOL',
            'if (...)EOL{',              // that's what you need
            'foreach (...) {EOL',
            '} else if (...) {EOL',
            '} elseif (...) {EOL',
            '} elseEOL{',               // and this
           );

}//end getPatterns()

如果您需要将相同的规则应用于其他控制结构，您可以采用相同的方式，通过更改数组中的模式。

更新:当然，一种更简洁的解决方案是编写您自己的类来扩展上述内容并覆盖 getPatterns() 方法。