Erik Porter's Blog

Hey man I think your example is cool but wrong. I think you just made a minor error.

If you use that snipet you will probly get stuck in an infinte loop.

sol.
private $type$ $property$
{
get { return _$property$;}
set { _$property$ = value;}
}
$end$

oops...typo...thanks...fixed!

Hmm, I would prefer to have the field in Camel case and the property in Pascal case, but I don't think that this is possible.

I'm with Thomas, the property should be CaMel cased.

Here's a macro to do it today in VS.NET 2003:

''' Creates a property.
''' format: type name has to be present at the current line.
''' Uses caMel casing.
Sub CreateProperty()
Dim typeName, propertyName, memberName, nameRead As String
Dim ts As TextSelection
Dim sb As New StringBuilder
Dim boolIsOpened As Boolean

Try
ts = DTE.ActiveDocument.Selection
If (ts.IsEmpty) Then
ts.SelectLine()
End If

typeName = (ts.Text.Split(" ")(0)).Trim()
nameRead = ((ts.Text.Split(" ")(1))).Trim()
propertyName = nameRead.Substring(0, 1).ToUpper & nameRead.Substring(1)
memberName = "_" + nameRead.Substring(0, 1).ToLower() & nameRead.Substring(1)

' actual property
sb.Append("/// <summary>" & Environment.NewLine)
sb.AppendFormat("/// Gets / sets {0}{1}", nameRead, Environment.NewLine)
sb.Append("/// </summary>" & Environment.NewLine)
sb.Append("public " + typeName + " " + propertyName)
sb.Append(vbCrLf)
sb.Append("{")
sb.Append(vbCrLf)

' get
sb.Append("get")
sb.Append(vbCrLf)
sb.Append("{")
sb.Append(vbCrLf)
sb.AppendFormat("return {0};", memberName)
sb.Append(vbCrLf)
sb.Append("}")
sb.Append(vbCrLf)

' set
sb.Append("set")
sb.Append(vbCrLf)
sb.Append("{")
sb.Append(vbCrLf)
sb.AppendFormat("{0} = value;", memberName)
sb.Append(vbCrLf)
sb.Append("}")
sb.Append(vbCrLf)
sb.Append("}")
sb.Append(vbCrLf)
sb.Append(vbCrLf)

'Check to see if UndoContext object is already open.
If DTE.UndoContext.IsOpen = False Then
'Open the UndoContext object to track changes.
Call DTE.UndoContext.Open("CreateProperty " & propertyName, False)
boolIsOpened = True
End If

' Replace the text
ts.Delete()
ts.Insert(sb.ToString(), vsInsertFlags.vsInsertFlagsInsertAtStart)
Finally

'If UndoContext was already open, don't close it.
If boolIsOpened = True Then
'Close the UndoContext object to commit the changes.
DTE.UndoContext.Close()
' Format the Selection
ts.SmartFormat()
ts.MoveToPoint(ts.BottomPoint.CreateEditPoint())
ts.LineUp()
End If
End Try
End Sub


Simply do this:

int foo
then at that line hit the key combi which executes the macro and you'll get:

/// <summary>
/// Gets / sets foo
/// </summary>
public int Foo
{
get
{
return _foo;
}
set
{
_foo = value;
}
}

Thomas, I talked with Joe N on the C# team about functions in snippets. He said it's something he's been pushing to get in there, but doubts it will for VS 2005.

Frans, that's fine...there are bunches of macros out there for that, but this entry is talking about code snippets in VS 2005. And in the future, please post code as a new entry and link to me, not in the comment...thanks. Also, that is your opinion that it should be cased like that...not a fact that it "should" be that way. ;)

You can improve the snippet a little by adding the auto documentation as follows

private $type$ $property$;

/// <summary>

     /// gets/sets the $property$.

     /// </summary>

     /// <value>The $property$</value>

private $type$ $property$

{

get { return _$property$;}

set { _$property$ = value;}

}

$end$

Autodocumentation is meaningless and only makes code harder to read maintain.

It states the obvious, but the point of documentation is to explain the non-obvious.