rspec/rules/S1888/rule.adoc

This rule allows you to check for certain types of comments before each method. For example, you may want to check for a Doxygen @author comment before each method. 


== Noncompliant Code Example

With regular expression: ``++//! @brief[ \t]+[a-zA-Z ]+++``:

----
bool TEST_CLASS_OK::Method(int nArg)  // Noncompliant
{
  return true;
}{code}

----

== Compliant Solution

----
//-------------------------------------------------------------------------
//! @brief    Method
//-------------------------------------------------------------------------
bool TEST_CLASS_OK::Method(int nArg)
{
  return true;
}
----