2007-05-21

Infoga Do-nothing-kommentarer

Infoga alltid en //Do nothing kommentar på ställen där avsikten är att inget ska utföras.

Anta t.ex. att du har en konstructor i en Control som ärver av WebControl och det enda du vill göra är att ändra vilken tag som ska användas.
public MyControl()
:base(HtmlTextWriterTag.Div)
{
}
När någon annan senare läser koden (eller du själv en månad senare när du glömt allt) är risken stor att man undrar om koden är klar eller om det saknas något i konstruktorn eftersom den är tom. Genom att knacka in en kommentar tydliggör du för dig själv och andra att den verkligen ska vara tom.
public MyControl()
:base(HtmlTextWriterTag.Div)
{
//Do nothing
}

Jag har en code snippet för det här så jag behöver bara skriva don och trycka tab två gånger så infogas //Do nothing.

Inga kommentarer: