Philips.CodeAnalysis.MaintainabilityAnalyzers.md

Rule ID	Title	Description
PH2001	Avoid empty XML Summary comments	Summary XML comments for classes, methods, etc. must be non-empty or non-existent.
PH2006	Match namespace and path	The File Path and Namespace must match. To include folders in the namespace, add dotnet_code_quality.PH2006.folder_in_namespace = true to the .editorconfig.
PH2020	Avoid Thread.Sleep	This method is a code smell.
PH2021	Avoid inline new	Do not inline the constructor call. Instead, create a local variable or a field for the temporary instance.
PH2026	Avoid SuppressMessage attribute	SuppressMessage results in violations of codified coding guidelines.
PH2027	Avoid static methods	Static methods complicate Unit Testing.
PH2028	Copyright present	The top of the file should have a copyright statement. It should include: '©' or 'Copyright', the year and the company name if such is configured in the .editorconfig
PH2029	Avoid #pragma	#pragmas result in violations of codified coding guidelines.
PH2030	Variable naming conventions	Fields look like _foo. Locals look like foo. (This analyzer does not respect IntelliSense settings in the .editorconfig. It assumes this is your naming convention.)
PH2031	Avoid TryParse without Culture	When interpreting a string as a number, always specify culture information.
PH2032	Avoid Empty Type Initializer	Empty type initializers are unnecessary.
PH2040	ServiceContracts have InterfaceContracts	Interfaces marked with [ServiceContract] must have methods marked with [OperationContract]
PH2042	WinForms InitalizeComponent	Legacy WinForms must call InitializeComponent exactly once. (As we moved away from static classes, and introduced construtor injection patterns, this pattern requires refactoring legacy code, and we found ourselves breaking these legacy forms.)
PH2044	Avoid dynamic keyword	The dynamic keyword is not checked for type safety at compile time.
PH2045	Avoid static classes	Static classes complicate Unite Testing. This rule supports a whitelist, one class per line, in a file named StaticClasses.Allowed.txt in the project marked as an AdditionalFile.
PH2047	Avoid public member variables	Avoid public fields in a class. Declare public property if needed for static fields.
PH2051	Avoid unnecessary range checks	Do not superfluously check the length of a List or Array before iterating over it.
PH2060	Bool naming conventions	Bool names start with is, are, should, has, does, or was.
PH2061	Public/Private #regions	Regions called Non-Public Data Members, Non-Public Properties/Methods or Public Interface must have appropriate contents
PH2064	Avoid duplicate #regions	A class cannot have regions of the same name.
PH2066	Readonly lock	Locks are readonly.
PH2067	Avoid nested string.Format	Don't nest string.Format (or similar) methods.
PH2068	Avoid goto	Avoid goto.
PH2069	Avoid unnecessary string.Format	Don't call string.Format unnecessarily.
PH2070	Avoid protected fields	Avoid protected fields.
PH2072	Require local editorconfig	Disabled by default. As of VS 16.3, Analyzers can now see settings of Editorconfig files in parent folders.
PH2073	Call extension method as instance	If Foo is an extension method of MyClass, call it as MyClass.Foo.
PH2074	Avoid register in Dispose	Dispose methods should unregister rather than register.
PH2075	Avoid AssemblyVersion change	Do not accidentally change AssemblyVersion, as it breaks runtime compatibility. Specify the intended dotnet_code_quality.PH2075.assembly_version in an .editorconfig specific to the project. Because this analyzer is not associated with a file, use a .globalconfig file when disabling this analyzer is desired, as described here.
PH2077	Avoid Switch statement with no cases	Avoid Switch statements when there are no cases
PH2078	Avoid PrivateKey Property	Do not use PrivateKey property on X509Certificate2 class as it might cause the Application to crash. Use a Getter instead. Eg: GetRSAPrivateKey(), GetDSAPrivateKey(), GetECDsaPrivateKey()
PH2079	Namespace prefix	Specify a namespace prefix in the .editorconfig file Eg. dotnet_code_quality.PH2079.namespace_prefix = [OrganizationName].[ProductName] and use that prefix for all projects/namespaces
PH2080	Avoid hardcoded absolute paths	Avoid hardcoded absolute paths (Windows only)
PH2081	Avoid #regions within methods	A #region cannot start or end within a method. Consider refactoring long methods instead.
PH2082	Positive naming	Name properties, fields and variables should be named using positive wording. People can handle double negations poorly, and by using positive wording these are prevented.
PH2083	Avoid Pass By Reference	Parameters that are passed by reference should be written to, otherwise they should not be passed by reference
PH2084	Don't lock on "new x()"	Locking on a newly created object has no effect
PH2085	Order property accessors	Consistently order property accessors as get, set, init
PH2086	Avoid calling Task.Result	Avoid calling Task.Result
PH2087	Do not use spaces in filenames	Not all tools handle files correctly that have spaces in their names. Homebrew scripts are prone to this for example.
PH2088	Paths should not exceed 260 characters	This prevents your code to run correctly on older Windows version.
PH2089	Avoid assignments in conditions	Conditions shouldn't have any side effects. Assign a variable outside of the condition instead.
PH2090	Log Exception	Log any of the caught exceptions. The Log method names are configurable either in the .editorconfig using key: 'dotnet_code_quality.PH2090.log_method_names' or by adding an named AllowedLogMethods.txt.
PH2091	Throw Inner Exception	When throwing an exception inside a catch block, include the original exception as arguments. This will show the inner exception also in a Callstack, aiding debugability.
PH2092	Limit Condition Complexity	Limit the number of logical expressions in a single condition. Humans are not very good of keeping track of large logical expressions. The maximum allowed number is configurable in the .editorconfig using key: 'dotnet_code_quality.PH2092.max_operators'.
PH2093	Prefer creating tuples with named fields	When creating or accepting a tuple, provide names for the fields (IE, prefer (DateTime createdAt, int id) rather than (DateTime, int)
PH2094	Prefer using the named tuple field, not ItemX	Wherever possible, use the provided name of a tuple field, not the generic name. (IE, (DateTime createdAt, int id) value; value.Item1.ToString(), prefer value.createdAt.ToString()
PH2096	Prefer async Task methods over async void methods	Wherever possible return Task rather then void for async methods. Exception are Event handlers
PH2097	Avoid Empty Statement Blocks	Avoid empty statement blocks
PH2098	Avoid Empty Catch Block	Avoid try-catch-swallow pattern
PH2099	Enforce FileVersion to be same as PackageVersion	For NuGet packages, this analyzer enforces that the .NET AssemblyFileVersion is equal to the AssemblyInformationalVersion. AssemblyFileVersion is not used at runtime, so it is helpful for it to match the Package Version. Set it with the <FileVersion> tag in the project file. If not set, it will inherit from <AssemblyVersion>, which if not set will inherit from <Version>
PH2101	Detect Null Dereference after "as"	After "as" include null checks; or, use static cast to set expectations.
PH2102	Xml documentation should add value	The content of the summary block of the inline XML code documentation, should add more information then merely repeating its name.
PH2103	Avoid method calls as arguments	Avoid method calls as arguments to method calls. For example, avoid Foo(Meow())
PH2104	Every Linq statement on separate line	Put every linq statement on a separate line, this makes it easier for a reader to follow the steps.
PH2105	Align number of + and - operators	Overload the minus (-) operator, when you overload the plus (+) operator, as these are often used in combination with each other.
PH2106	Align number of * and / operators	Overload the divide (/) operator, when you overload the multiple (*) operator, as these are often used in combination with each other.
PH2107	Align number of > and < operators	Overload the smaller than (<) operator, when you overload the greater than (>) operator, as these are often used in combination with each other.
PH2108	Align number of >= and <= operators	Overload the smaller or equal (<=) operator, when you overload the greater or equal (>=) operator, as these are often used in combination with each other.
PH2109	Align number of >> and << operators	Overload the left shift (<<) operator, when you overload the right shift (>>) operator, as these are often used in combination with each other.
PH2110	Align number of ++ and -- operators	Overload the increment (--) operator, when you overload the increment (++) operator, as these are often used in combination with each other.
PH2111	Reduce Cognitive Load	Reduce the number of logical cases, negations, or especially nested blocks in this method. Extracting a method is the typical solution.
PH2112	Avoid overridde with new keyword	Overriding with the new keyword gives unexpected behavior for the callers of the overridden method or property.
PH2113	Merge If Statements	Nested If statements lacking else clauses and containing the same body can be safely merged to reduce cognitive load
PH2114	Avoid empty statement	Avoid empty statements.
PH2115	Every Lambda expression on separate line	Avoid putting multiple lambda statements on a single line for readability.
PH2116	Avoid ArrayList	Usage of Arraylist is discouraged by Microsoft for performance reasons, use List instead.
PH2117	Avoid Unnecessary Where()	Move the predicate of the Where clause into the Any(), Count(), First(), Last(), or Single() clause
PH2118	Avoid inline magic numbers	Avoid inline magic number, define them as constant or include in an enumeration instead.
PH2119	Cast complete object	A cast should include all information from the previous type. By casting to a type of one of the fields, the cast is losing information. Use an AsType() or ToType() method instead.
PH2120	Document thrown exceptions	Be clear to your callers what exception can be thrown from your method by mentioning each of them in an element in the documentation of the method.
PH2121	Throw informational exceptions	Specify context to a thrown exception, by using a constructor overload that sets the Message property.
PH2122	Avoid Exceptions from unexpected locations	Avoid throwing exceptions from unexpected locations, like Finalizers, Dispose, Static Constructors, some operators, and overidden methods of Object.
PH2123	Pass sender to EventHandler	Prevent passing null values for sender/object to event handler (for instance-based events).
PH2124	Document unhandled exceptions	Be clear to your callers what exception can be thrown from your method (or any called methods) by mentioning each of them in an element in the documentation of the method.
PH2125	Align number of + and == operators	Overload the equality operator (==), when you overload the addition (+) operator.
PH2126	Avoid using Parameters as temporary variables	Don't use parameters as temporary variables, define a local variable instead.
PH2127	Avoid changing loop variables	Don't change loop variables, this gives unexpected loop iterations. Use continue and break instead.
PH2128	Split multi-line condition on logical operator	In case that the condition of an "if" or "?" statement covers more then one line, its line endings should be right after the logical operators (&& and
PH2129	Return immutable collections	Return only immutable or readonly collections from a public method, otherwise these collections can be changed by the caller without the callee noticing.
PH2130	Avoid implementing finalizers	Avoid implement a finalizer, use Dispose instead. If the class has unmanaged fields, finalizers are allowed if they only call Dispose.
PH2131	Align filename and class name	Name the file after the class, struct or enum it contains.
PH2132	Remove commented code	Remove commented code.
PH2133	Unmanaged objects need disposing	Every field which holds an unmanaged object needs to be declared in a class that implements IDisposable.
PH2134	Set properties in any order	Getting other properties in a setter makes this setter dependent on the order in which these properties are set.
PH2135	Match namespace and Assembly Name	The Assembly Name and Namespace must match.
PH2136	Avoid duplicate strings	Duplicate strings are less maintainable.
PH2138	Avoid void returns	Methods that return void are mysterious.
PH2139	Enable documentation creation	Add XML documentation generation to the project file, to be able to see Diagnostics for XML documentation.
PH2140	Avoid ExcludeFromCodeCoverage attribute	Avoid the usage of the 'ExcludeFromCodeCoverage' attribute.
PH2141	Avoid Empty Regions	Avoid writing regions that have no code inside.
PH2143	Avoid Assembly.GetEntryAssembly()	Avoid using Assembly.GetEntryAssembly(), as it might give different results when your code runs under a TestRunner.
PH2146	Avoid calling ToString() on string type	Calling ToString() on an expression that is already of type string is redundant and should be removed.