Was sind die C# "Formatierungs" -Standards?

Question

In C# (. NET), was sind die regulären "Formatierungs" -Standards?

Zum Beispiel für Parameter Namen, bis jetzt bemerkte ich CamelCase ohne Präfix, ist das richtig? Für Objektnamen, CamelCase und keine Präfix entweder, oder?

Für Namespaces, Klassen, Funktionen und Eigenschaften wird der erste Buchstabe des Wortes großgeschrieben und es gibt kein Präfix, ist das richtig (wieder)?

Wie werden "temporäre" Objekte formatiert?

Beispiel:

namespace TestNamespace 
{ 
    class MyOwnCoolClass 
    { 
     MyOwnCoolClass(int length, BinaryWriter writer) 
     { 
      BinaryWriter tempbw = new BinaryWriter(length); 
      return tempbw; 
     } 
    } 
} 

(Hinweis: Dieser Code nicht gültig ist, weiß ich, es ist nur die Formatierung zeigen). Danke!

Answer 1

Wenn Sie StyleCop verwenden, erhalten Sie eine gute Konsistenz mit der Microsoft .NET Design Guidelines for Developing Class Libraries. StyleCop erzwingt auch mehrere zusätzliche Dinge wie Abstand, Reihenfolge der Elemente in einer Datei und Benennung von nicht-öffentlichen Code-Elementen.

Answer 2

Vollständige Richtlinien von Microsoft finden Sie in der Class Design Guidelines. Es ist alt, aber ich habe noch nichts aktualisiert auf MSDN gefunden, und ich glaube, es ist immer noch die Standardsatzempfehlungen

Answer 3

Ich würde am folgenden Coding Practices.

einen Blick Es deckt praktisch alles, was ich in den meisten C# -Code zu sehen, die ich gelesen ... einschließlich UI-Elemente prefixing. Ich persönlich folge es nicht dem Buchstaben, aber es gibt Ihnen eine gute Idee des allgemeinen Standards und was gut/schlecht Praxis ist.

Answer 4

Es gibt Verweise auf Microsoft-Codierungsstandards. In Visual Studio 2005 und 2008 ist eine Code Analysis-Engine integriert, die Sie durch diese Codierungsstandards führt und Sie auch auf einige Best Practices hinweist. Klicken Sie mit der rechten Maustaste auf Ihr Projekt und klicken Sie auf "Codeanalyse im Projekt ausführen".

Immer wenn ein ungültiger oder weniger bevorzugter Codeabschnitt entdeckt wird, warnt er Sie nicht nur, sondern verweist Sie auf eine Hilfefunktion auf der FxCop-Site.

Answer 5

MSDN: Naming Guidelines

Ich neige dazu, zu verfolgen, wie die .NET-Framework ist kodiert, so meinen Code mit .NET Framework konsistent ist.

Meine einzige persönliche Präferenz ist die Benennung von Klassenvariablen, die ich das Präfix "m_" vor jeder Variablen wie private int m_count verwenden.

Answer 6

Sie können die Kombination StyleCop und FxCop (oder die integrierte Codeanalyse für VS2008 Pro) für Werkzeuge und die Framework Design Guidelines verwenden.

Answer 7

Ich schrieb these guidelines über das letzte Jahr mit verschiedenen Richtlinien von MSFT und anderen weithin akzeptierten Richtlinien. Vielleicht möchten Sie es überprüfen, es hat auch andere Dinge, wie das Einrichten von Projekten und was nicht, aber alle Benennungsrichtlinien sind auch da.

bearbeiten: Ich bemerkte, dass dies eine alte Version ist, ich habe eine neue Version, die ich für eine Weile geschrieben habe und es enthält viele Leckereien, aber es ist nicht getan. Ich werde diesen Beitrag aktualisieren, wenn es veröffentlicht wird.