[StyleCop] Habilitar/Deshabilitar reglas en nuestros desarrollos
Una de las caracterisitcas que StyleCop nos provee es que podemos habilitar/deshabilitar las reglas que no creemos oportunas en nuestros desarrollos, por ejemplo, en mi caso vamos a deshabilitar 2 reglas:
SA1632: The documentation text within the param tag must be at least 10 characters in length. Documentation failing to meet this guideline most likely does not follow a proper grammatical structure required for documentation text.
SA1630: The documentation text within the summary tag does not contain any whitespace between words, indicating that it most likely does not follow a proper grammatical structure required for documentation text.
La primera saltará cuando la longitud del parámetro es menor de 10 caracteres. Cuando utilizas GhostDoc y comentas por ejemplo un constructor salta por que algunos parámetros los toma literalmente del nombre del parámetro, como en el caso de suit:
/// <summary>
/// Initializes a new instance of the <see cref="Card"/> class.
/// </summary>
/// <param name="suit">The suit.</param>
/// <param name="faceVal">The face val.</param>
/// <param name="isCardUp">if set to <c>true</c> [is card up].</param>
public Card(Suit suit, FaceValue faceVal, bool isCardUp)
{
this.suit = suit;
this.faceVal = faceVal;
this.isCardUp = isCardUp;
}
La segunda saltará cuando el tag summary no tiene espacios entre palabras, pero sí por ejemplo, con una sola palabra queda claro como en este caso es el tipo de jugador:
namespace Blackjinet.Entities.Enums
{
/// <summary>
/// Player's Type
/// </summary>
public enum PlayerType
{
/// <summary>
/// Dealer
/// </summary>
Dealer,
/// <summary>
/// Player
/// </summary>
Player
}
}
Bueno pues vamos a ver como deshabilitamos estas reglas y tenemos 2 opciones (sí alguien sabe alguna más, bienvenida será):
En la ruta de la imagen (C:\Program Files\Microsoft StyleCop 4.3.1.3), tenemos un archivo Settings donde se almacenan las reglas de StyleCop
Sí lo ejecutamos podemos ver la reglas organizadas por categorías:
Para aplicar las reglas a nivel de solución, copiamos este archivo en el directorio donde se encuentra nuestra solución (.sln)
Lo abrimos, deshabilitamos las reglas y pulsamos OK:
Con esto dehabilitamos esas 2 reglas para toda la solución.
Para deshabilitar reglas a nivel de proyecto, lo podemos hacer a través del Visual Studio:
Seleccionando el proyecto –> Botón derecho –> StyleCop Settings
Eso sí, la modificación de estas reglas solo aplican para el proyecto que estamos modificando.
Salu2