Gendarme rule to check COM registration methods
completed by: Yuri Stuken
Gendarme is a static analysis tool to find problems in .NET software. Gendarme inspects executables and libraries that contain code in ECMA CIL format (Mono and .NET) and looks for common problems with the code, problems that compiler do not typically check or have not historically checked.
The task is to write one Gendarme rule that implement the same logic behind both the FxCop rules:
- CA1410 http://msdn.microsoft.com/en-us/library/ms182200.aspx
- CA1411 http://msdn.microsoft.com/en-us/library/ms182201.aspx
i.e. to ensure COM registration method are matched () and non-visible. The merged rule name should be ReviewComRegistrationMethodsRule
To complete the task the student must provide:
* the rule, written in C#. The source code must follow the Mono source code guidelines (available at http://www.mono-project.com/Coding_Guidelines). Also a 'self-check' must be done one the code (i.e. you need to run gendarme on your own code) and the defects, if any, must be fixed (in doubt please ask for guidance on IRC).
* its documentation (in-source xmldoc) that includes 'good' and 'bad' examples; and
* the unit tests (also in C# using the gendarme helpers around NUnit) proving the rule is working as intended. Note that this rule has many special cases to consider and all of them should be part of the unit tests;
Once ready the files (or the patch) can be submitted to the mentor for review.
* In order to avoid misunderstandings you should start by writing your unit tests and ask for a review of them. That will quickly tell you if you're on the right path to solve the problem.
* Gendarme provides hundreds of rules that can be used as example, here's one
* Gendarme web site: http://www.mono-project.com/Gendarme
* Mailing-list / discussions: http://groups.google.com/group/gendarme
* IRC: #gendarme on GimpNET