void header comment?

Permanently deleted user

Created October 28, 2014 14:16

Hi,

is it possible to create a shortcut to insert a comment-block below the void-start line?

Example:

private void Testvoid(string testS)
{
     MessageBox.Show("TEST");
}

Example with Shortcut:

private void Testvoid(string testS)
// ***************************************************************************
// *                                                                                           *
// * Testvoid: Text text text text...                                                *
// *                                                                                           *
// *     INPUT: string testS                                                          *
// *                                                                                           *
// ***************************************************************************
{
     MessageBox.Show("TEST");
}

Thanks a lot
Best Regards
rene

1 comment

Richard Deeming

Created October 29, 2014 11:28

Rather than inventing your own syntax, why not use the standard XML Documentation Comments? That way, you'll get documentation in IntelliSense, and you can compile an API help-file directly from the comments.

/// <summary>
/// Text text text text...
/// </summary>
/// <param name="testS">
/// string testS ...
/// </param>
private void Testvoid(string testS)
{
   ...
}

Please sign in to leave a comment.