PO::comment_block
Prepare a text as a comment -- wraps the lines and prepends # and a special character to each line
Signature
public function comment_block(string
$text,
[string
$char = ' '] )
Parameters
$text
—
string
- the comment text
$char
—
string
- character to denote a special PO comment,
like :, default is a space
Violations
Checkstyle
Line |
Column |
Severity |
Message |
195 |
1 |
error
|
Spaces must be used for alignment; tabs are not allowed |
195 |
5 |
error
|
Line indented incorrectly; expected 8 spaces, found 4 |
195 |
19 |
error
|
Method name "PO::comment_block" is not in camel caps format |
195 |
54 |
error
|
Incorrect spacing between argument "$char" and equals sign; expected 1 but found 0 |
195 |
54 |
error
|
Incorrect spacing between default value and equals sign for argument "$char"; expected 1 but found 0 |
195 |
60 |
error
|
Opening brace should be on a new line |
196 |
1 |
error
|
Spaces must be used for alignment; tabs are not allowed |
196 |
9 |
error
|
Line indented incorrectly; expected at least 12 spaces, found 8 |
197 |
1 |
error
|
Spaces must be used for alignment; tabs are not allowed |
197 |
9 |
error
|
Line indented incorrectly; expected at least 12 spaces, found 8 |
198 |
1 |
error
|
Spaces must be used for alignment; tabs are not allowed |
198 |
5 |
error
|
Line indented incorrectly; expected 8 spaces, found 4 |