Do not store Urls hardcoded in Assembly |
Remove hard coded Urls from the code and make them configurable.
| CheckId | SPC040209 |
|---|---|
| TypeName | DoNotStoreUrlsHardCodedInAssemblies |
| Severity | CriticalWarning |
| Type | Assembly |
Remove the string from the code and make it configurable e.g. via PropertyBag or a SharePoint list.
The rule can only check for fixed strings in the code which start with 'http' and contains '.aspx'. This is done to avoid problems with xml namespaces which also are Urls.
To suppress this violation in managed code add the following attribute to the method which contains the instruction (available since SPCAF version v5.2). Learn more about SuppressMessage here.
// Important: Ensure to have #define CODE_ANALYSIS at the beginning of your .cs file
[SuppressMessage("SPCAF.Rules.DesignGroup", "SPC040209:DoNotStoreUrlsHardCodedInAssemblies", Justification = "Provide reason for suppression here")]
[SuppressMessage("SPCAF.Rules.DesignGroup", "SPC040209:DoNotStoreUrlsHardCodedInAssemblies", Justification = "Provide reason for suppression here")]
Disclaimer: The views and opinions expressed in this documentation and in SPCAF do not necessarily reflect the opinions and recommendations of Microsoft or any member of Microsoft. SPCAF and RENCORE are registered trademarks of Rencore. All other trademarks, service marks, collective marks, copyrights, registered names, and marks used or cited by this documentation are the property of their respective owners.