Namn på typmedlemmar
Kommentar
Det här innehållet skrivs om med behörighet från Pearson Education, Inc. från Framework Design Guidelines: Conventions, Idioms, and Patterns for Reusable .NET Libraries, 2nd Edition. Den utgåvan publicerades 2008, och boken har sedan dess reviderats helt i den tredje utgåvan. En del av informationen på den här sidan kan vara inaktuell.
Typer består av medlemmar: metoder, egenskaper, händelser, konstruktorer och fält. I följande avsnitt beskrivs riktlinjer för namngivning av medlemmar.
Namn på metoder
Eftersom metoder är ett sätt att vidta åtgärder kräver designriktlinjerna att metodnamnen är verb eller verbfraser. Genom att följa den här riktlinjen kan du också skilja metodnamn från egenskaps- och typnamn, som är substantiv- eller adjektivfraser.
✔️ GE metoder namn som är verb eller verbfraser.
public class String {
public int CompareTo(...);
public string[] Split(...);
public string Trim();
}
Namn på egenskaper
Till skillnad från andra medlemmar bör egenskaper ges substantivfras eller adjektivnamn. Det beror på att en egenskap refererar till data, och namnet på egenskapen återspeglar det. PascalCasing används alltid för egenskapsnamn.
✔️ DO-namnegenskaper med ett substantiv, substantivfras eller adjektiv.
❌ HA INTE egenskaper som matchar namnet på "Get"-metoder som i följande exempel:
public string TextWriter { get {...} set {...} }
public string GetTextWriter(int value) { ... }
Det här mönstret anger vanligtvis att egenskapen verkligen ska vara en metod.
✔️ DO-namnsamlingsegenskaper med en pluralfras som beskriver objekten i samlingen i stället för att använda en singulär fras följt av "Lista" eller "Samling".
✔️ Do name Boolean properties with an affirmative phrase (CanSeek instead of CantSeek). Du kan också prefixet Booleska egenskaper med "Is", "Can" eller "Has", men bara där det lägger till värde.
✔️ ÖVERVÄG att ge en egenskap samma namn som dess typ.
Följande egenskap hämtar och anger till exempel ett uppräkningsvärde med namnet Color, så egenskapen heter Color:
public enum Color {...}
public class Control {
public Color Color { get {...} set {...} }
}
Namn på händelser
Händelser refererar alltid till någon åtgärd, antingen en som inträffar eller en som har inträffat. Precis som med metoder namnges händelser med verb, och verbtempus används därför för att ange den tid då händelsen utlöses.
✔️ DO-namnhändelser med ett verb eller en verbfras.
Exempel är Clicked, Painting, DroppedDownoch så vidare.
✔️ GE händelser namn med ett begrepp om före och efter, med hjälp av nutid och tidigare tempus.
Till exempel anropas Closingen stängningshändelse som utlöses innan ett fönster stängs och en som aktiveras när fönstret stängs anropas Closed.
❌ Använd INTE prefix eller postfix för "Före" eller "Efter" för att ange pre- och posthändelser. Använd nutida och tidigare tempus enligt beskrivningen.
✔️ DO-namnhändelsehanterare (ombud som används som typer av händelser) med suffixet "EventHandler", som visas i följande exempel:
public delegate void ClickedEventHandler(object sender, ClickedEventArgs e);
✔️ ANVÄND två parametrar med namnet sender och e i händelsehanterare.
Avsändarparametern representerar det objekt som skapade händelsen. Avsändarparametern är vanligtvis av typen object, även om det är möjligt att använda en mer specifik typ.
✔️ Do name event argument classes med suffixet "EventArgs".
Namn på fält
Riktlinjerna för namngivning av fält gäller för statiska offentliga och skyddade fält. Interna och privata fält omfattas inte av riktlinjer och offentliga eller skyddade instansfält tillåts inte av riktlinjerna för medlemsdesign.
✔️ ANVÄND PascalCasing i fältnamn.
✔️ DO-namnfält med ett substantiv, substantivfras eller adjektiv.
❌ Använd INTE ett prefix för fältnamn.
Använd till exempel inte "g_" eller "s_" för att ange statiska fält.
Portioner © 2005, 2009 Microsoft Corporation. Med ensamrätt.
Reprinted by permission of Pearson Education, Inc. from Framework Design Guidelines: Conventions, Idioms, and Patterns for Reusable .NET Libraries, 2nd Edition by Krzysztof Cwalina and Brad Abrams, publicerad 22 okt 2008 av Addison-Wesley Professional som en del av Microsoft Windows Development Series.