This repository was archived by the owner on Sep 19, 2023. It is now read-only.
File tree Expand file tree Collapse file tree 2 files changed +16
-1
lines changed Expand file tree Collapse file tree 2 files changed +16
-1
lines changed Original file line number Diff line number Diff line change @@ -5,4 +5,18 @@ Installation instructions:
5
5
1 . Clone repository on your drive
6
6
2 . Run ` composer install `
7
7
2 . Run: ` chmod +x phpcsx phpmd `
8
- 3 . Configure your PhpStorm to use both scripts
8
+ 3 . Configure your PhpStorm to use both scripts
9
+ 4 . (Optional) Open PhpStorm Settings -> Editor -> File and Code Templates [ Includes] -> Php Function Doc Comment
10
+ And replace content with:
11
+ ``` java
12
+ #set( $name = ${NAME } )
13
+ /**
14
+ * $name.substring(0,1).toUpperCase()$name.substring(1).replaceAll("([A-Z])", " $1")
15
+ *
16
+ ${PARAM_DOC}
17
+ #if (${TYPE_HINT} != "void") * @return ${TYPE_HINT}
18
+ #end
19
+ ${THROWS_DOC}
20
+ */
21
+ ```
22
+ This will generate a ** short description** for functions and methods with Function / Method name.
Original file line number Diff line number Diff line change 26
26
<exclude name =" Squiz.Commenting.FunctionComment.ParamCommentFullStop" />
27
27
<exclude name =" Squiz.Commenting.FunctionComment.SpacingAfterParamType" />
28
28
<exclude name =" Generic.Commenting.DocComment" />
29
+ <exclude name =" Squiz.Commenting.FunctionComment.MissingParamComment" />
29
30
</rule >
30
31
<rule ref =" JustcodedPSR2.Commenting.DocComment" />
31
32
</ruleset >
You can’t perform that action at this time.
0 commit comments