phpcs: Missing parameter comment
up vote
0
down vote
favorite
I have the following code:
/**
* @param TranscodingJob $transcodingJob
*
* @return TranscodingJob
* @throws LexikBundleWorkflowBundleExceptionWorkflowException
*/
public function onTranscodingJobError(TranscodingJob $transcodingJob) { ...
... and I find that when I hover over the annotation, this note appears:
phpcs: Missing parameter comment
How can I modify my annotations to make the complaint go away?
(I have tried simply adding text above the annotation for the parameter, and that doesn't seem to fix it.)
php phpstorm phpcs
asked Aug 7 at 9:03
Patrick at work
349113
add a comment |
up vote
0
down vote
favorite
I have the following code:
/**
* @param TranscodingJob $transcodingJob
*
* @return TranscodingJob
* @throws LexikBundleWorkflowBundleExceptionWorkflowException
*/
public function onTranscodingJobError(TranscodingJob $transcodingJob) { ...
... and I find that when I hover over the annotation, this note appears:
phpcs: Missing parameter comment
How can I modify my annotations to make the complaint go away?
(I have tried simply adding text above the annotation for the parameter, and that doesn't seem to fix it.)
php phpstorm phpcs
asked Aug 7 at 9:03
Patrick at work
349113
@param TranscodingJob $transcodingJob My comment-- like that.
– LazyOne
Aug 7 at 9:21
Huh. That didn't seem to work before, but it does now. Thanks!
– Patrick at work
Aug 7 at 9:22
add a comment |
up vote
0
down vote
favorite
up vote
0
down vote
favorite
I have the following code:
/**
* @param TranscodingJob $transcodingJob
*
* @return TranscodingJob
* @throws LexikBundleWorkflowBundleExceptionWorkflowException
*/
public function onTranscodingJobError(TranscodingJob $transcodingJob) { ...
... and I find that when I hover over the annotation, this note appears:
phpcs: Missing parameter comment
How can I modify my annotations to make the complaint go away?
(I have tried simply adding text above the annotation for the parameter, and that doesn't seem to fix it.)
php phpstorm phpcs
asked Aug 7 at 9:03
Patrick at work
349113
I have the following code:
/**
* @param TranscodingJob $transcodingJob
*
* @return TranscodingJob
* @throws LexikBundleWorkflowBundleExceptionWorkflowException
*/
public function onTranscodingJobError(TranscodingJob $transcodingJob) { ...
... and I find that when I hover over the annotation, this note appears:
phpcs: Missing parameter comment
How can I modify my annotations to make the complaint go away?
(I have tried simply adding text above the annotation for the parameter, and that doesn't seem to fix it.)
php phpstorm phpcs
php phpstorm phpcs
asked Aug 7 at 9:03
Patrick at work
349113
asked Aug 7 at 9:03
Patrick at work
349113
asked Aug 7 at 9:03
Patrick at work
349113
asked Aug 7 at 9:03
Patrick at work
349113
asked Aug 7 at 9:03
Patrick at work
349113
349113
@param TranscodingJob $transcodingJob My comment-- like that.
– LazyOne
Aug 7 at 9:21
Huh. That didn't seem to work before, but it does now. Thanks!
– Patrick at work
Aug 7 at 9:22
add a comment |
@param TranscodingJob $transcodingJob My comment-- like that.
– LazyOne
Aug 7 at 9:21
Huh. That didn't seem to work before, but it does now. Thanks!
– Patrick at work
Aug 7 at 9:22
@param TranscodingJob $transcodingJob My comment -- like that.– LazyOne
Aug 7 at 9:21
@param TranscodingJob $transcodingJob My comment -- like that.– LazyOne
Aug 7 at 9:21
Huh. That didn't seem to work before, but it does now. Thanks!
– Patrick at work
Aug 7 at 9:22
Huh. That didn't seem to work before, but it does now. Thanks!
– Patrick at work
Aug 7 at 9:22
add a comment |
1 Answer
1
active
oldest
votes
up vote
1
down vote
accepted
You need to add comment for your @param variable
Change your code as
/**
* @param TranscodingJob $transcodingJob comment about this variable
*
* @return TranscodingJob
* @throws LexikBundleWorkflowBundleExceptionWorkflowException
*/
answered Nov 12 at 5:48
M. Akeel Ahamed
464
add a comment |
Your Answer
StackExchange.ifUsing("editor", function () {
StackExchange.using("externalEditor", function () {
StackExchange.using("snippets", function () {
StackExchange.snippets.init();
});
});
}, "code-snippets");
StackExchange.ready(function() {
var channelOptions = {
tags: "".split(" "),
id: "1"
};
initTagRenderer("".split(" "), "".split(" "), channelOptions);
StackExchange.using("externalEditor", function() {
// Have to fire editor after snippets, if snippets enabled
if (StackExchange.settings.snippets.snippetsEnabled) {
StackExchange.using("snippets", function() {
createEditor();
});
}
else {
createEditor();
}
});
function createEditor() {
StackExchange.prepareEditor({
heartbeatType: 'answer',
convertImagesToLinks: true,
noModals: true,
showLowRepImageUploadWarning: true,
reputationToPostImages: 10,
bindNavPrevention: true,
postfix: "",
imageUploader: {
brandingHtml: "Powered by u003ca class="icon-imgur-white" href="https://imgur.com/"u003eu003c/au003e",
contentPolicyHtml: "User contributions licensed under u003ca href="https://creativecommons.org/licenses/by-sa/3.0/"u003ecc by-sa 3.0 with attribution requiredu003c/au003e u003ca href="https://stackoverflow.com/legal/content-policy"u003e(content policy)u003c/au003e",
allowUrls: true
},
onDemand: true,
discardSelector: ".discard-answer"
,immediatelyShowMarkdownHelp:true
});
}
});
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
StackExchange.ready(
function () {
StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2fstackoverflow.com%2fquestions%2f51722886%2fphpcs-missing-parameter-comment%23new-answer', 'question_page');
}
);
Post as a guest
Required, but never shown
1 Answer
1
active
oldest
votes
1 Answer
1
active
oldest
votes
active
oldest
votes
active
oldest
votes
up vote
1
down vote
accepted
You need to add comment for your @param variable
Change your code as
/**
* @param TranscodingJob $transcodingJob comment about this variable
*
* @return TranscodingJob
* @throws LexikBundleWorkflowBundleExceptionWorkflowException
*/
answered Nov 12 at 5:48
M. Akeel Ahamed
464
add a comment |
up vote
1
down vote
accepted
You need to add comment for your @param variable
Change your code as
/**
* @param TranscodingJob $transcodingJob comment about this variable
*
* @return TranscodingJob
* @throws LexikBundleWorkflowBundleExceptionWorkflowException
*/
answered Nov 12 at 5:48
M. Akeel Ahamed
464
add a comment |
up vote
1
down vote
accepted
up vote
1
down vote
accepted
You need to add comment for your @param variable
Change your code as
/**
* @param TranscodingJob $transcodingJob comment about this variable
*
* @return TranscodingJob
* @throws LexikBundleWorkflowBundleExceptionWorkflowException
*/
answered Nov 12 at 5:48
M. Akeel Ahamed
464
You need to add comment for your @param variable
Change your code as
/**
* @param TranscodingJob $transcodingJob comment about this variable
*
* @return TranscodingJob
* @throws LexikBundleWorkflowBundleExceptionWorkflowException
*/
answered Nov 12 at 5:48
M. Akeel Ahamed
464
answered Nov 12 at 5:48
M. Akeel Ahamed
464
answered Nov 12 at 5:48
M. Akeel Ahamed
464
answered Nov 12 at 5:48
M. Akeel Ahamed
464
464
add a comment |
add a comment |
Thanks for contributing an answer to Stack Overflow!
- Please be sure to answer the question. Provide details and share your research!
But avoid …
- Asking for help, clarification, or responding to other answers.
- Making statements based on opinion; back them up with references or personal experience.
To learn more, see our tips on writing great answers.
Some of your past answers have not been well-received, and you're in danger of being blocked from answering.
Please pay close attention to the following guidance:
- Please be sure to answer the question. Provide details and share your research!
But avoid …
- Asking for help, clarification, or responding to other answers.
- Making statements based on opinion; back them up with references or personal experience.
To learn more, see our tips on writing great answers.
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
StackExchange.ready(
function () {
StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2fstackoverflow.com%2fquestions%2f51722886%2fphpcs-missing-parameter-comment%23new-answer', 'question_page');
}
);
Post as a guest
Required, but never shown
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
@param TranscodingJob $transcodingJob My comment-- like that.– LazyOne
Aug 7 at 9:21
Huh. That didn't seem to work before, but it does now. Thanks!
– Patrick at work
Aug 7 at 9:22