Home
Do you always create suggestions when something is hard to do?
  v3.0 Posted at 30/01/2020 10:03 AM by Liam Elliott

One of our goals is to make the job of the developer as easy as possible. If you have to write a lot of code for something that you think you should not have to do, you should make a suggestion and add it to the relevant page.

If you have to add a suggestion, make sure that you put the link to that suggestion into the comments of your code.​​

/// <summary>
/// base class for command implementations
/// This is a work around as standard MVVM commands
/// are not provided by default.
/// </summary>
public class Command : ICommand
{
 // code
}​

Figure: Bad example - The link to the suggestion should be in the comments​

​/// <summary>
/// base class for command implementations
/// This is a work around as standard MVVM commands
/// are not provided by default.
/// </summary>
///
/// <remarks>
///  Issue Logged here: https://github.com/SSWConsulting/SSW.Rules/issues/3
///</remarks>
public class Command : ICommand
{
 // code
}

​Figure: Good example - Wh​​en you link to a suggestion everyone can find it and vote it up


Related rules

    Do you feel this rule needs an update?

    If you want to be notified when this rule is updated, please enter your email address:

    Comments: