Supress warnings inline?

MarcHenderkes

Hello,

I see how to suppress warnings on a project level with .editorconfig files, but what if I want to suppress warnings for a specific method or variable?

Something like this?

JakubMisek

That's an interesting feature.

So far we tried to avoid the need for editing source files in order to suppress/configure editor-specific warnings.

Currently, you can suppress warnings on file level with .editorconfig

[**/legacyfile.php]
php_diagnostic_php0405 = false

PHPDoc tag @suppress or @SuppressWarnings make sense. Do you know what is the standard approach by other editors?

MarcHenderkes

PHPmd uses @SuppressWarnings
https://phpmd.org/documentation/suppress-warnings.html

Eslint uses comments:
https://eslint.org/docs/2.13.1/user-guide/configuring#:_{:text=To%20disable%20rule%20warnings%20in,*%2F%20alert}('foo')%3B

C++ uses #pragma warning (disable: 0405)

Java uses @SuppressWarnings("fallthrough") like phpmd.

I think a phpdoc directive like phpmd uses makes the most sense here, but I'm fine with any solution.

Edit: phpstorm seems to do it a little differently. https://www.jetbrains.com/help/webstorm/2017.2/suppressing-inspections.html#d218485e53
I guess they save some metadata about the warning to suppress and where to suppress it, instead of the user specifying it in source code. Not the biggest fan of it, but a possibility for sure too.

JakubMisek

@MarcHenderkes I see :) thanks! we should be able to support @SuppressWarnings

MarcHenderkes

Cool, please remind me when this is implemented so I can go through some warnings :)

JakubMisek

Will be implemented in the next update (both VS Code and VS)!

Also, we can add a #suppress comment?

#suppress PHP0406

JakubMisek

@suppress and @suppresswarnings features available, download at https://www.devsense.com/en/download