Baz Hughes

Baz Hughes

  • NA
  • 3
  • 0

Comments / documentation style - changing to Javadoc or PHPDoc like syntax

May 7 2011 5:02 PM
For no reason other than personal preference I like to comment my methods something like this:

/**
 * Causes work to be done
 *
 * @param string workRequest
 */
public void DoWork(string workRequest)
{
        // etc...
}

As opposed to the standard:

/// <summary>
///     Causes work to be done
/// <summary>
/// <param name="workRequest"></param>
public void DoWork(string workRequest)
{
        // etc...
}

Is there any "quick fix" to tune VS2010 into using the first style? So that code-hinting will still work?

Answers (1)