Codierrichtlinien + Best Practices?

Question

Ich konnte keine Frage finden, die direkt auf meine Anfrage zutrifft, also poste ich dies als eine neue Frage. Wenn es eine Diskussion gibt, die mir helfen kann, weisen Sie bitte darauf hin und schließen Sie die Frage.

Frage:

Ich werde einen Vortrag über C# Code-Richtlinien tun, aber es soll nicht auf Coding-Standards begrenzen.

Also ich habe eine grobe Idee, aber ich denke, ich muss gute Programmierpraktiken ansprechen. Der Inhalt wird also ungefähr so ​​sein.

1. Grund Coding-Standards - Gehäuse, Formatierung usw.

2. Gute Praktiken - Verwendung von Hashset über andere Datenstrukturen, String vs String Builder, String der Unveränderlichkeit und mit ihnen effektiv etc

Wirklich möchte ich hinzufügen, mehr gute Praktiken (vor allem, um die Leistung zu verbessern.) So gerne einige gute Praktiken zu hören mit C# verwendet werden. Irgendwelche Vorschläge??? (Keine Notwendigkeit großer Beschreibungen :) Nur die Idee ist ausreichend.)

Answer 1

Coding Guidelines for CSharp 3.0 and 4.0

IDesign Coding Standards

Lance Hunt's C# Coding Standards

Brad Abrams' Internal Coding Guidelines

Es überrascht nicht, ich habe gerade eine Frage SO: C# Coding standard/Best practices

Answer 2

• Grundlegende Codierungsstandards - Stellen Sie sicher, dass sie konsistent sind. Selbst wenn sie nicht den in this document on msdn festgelegten Konventionen entsprechen. Ich denke, Konsistenz ist hier der Schlüssel.

• Komponententests - Sie können hier nichts falsch machen.

• Sicherheit - Sprechen Sie darüber, dass sensible Daten sicher übertragen werden.

• Leistung - Sie wissen, ich persönlich fühle, dass ich die Anwendung richtig und dann Leistung betrachten, was ich tue. Ich habe es im Hinterkopf, wenn ich Code schreibe, also sind es kleine feine Stimmungen, die am Ende kommen.

Answer 3

Hier sind ein paar Tipps:

1. Verwenden FxCop für die statische Analyse.
2. Verwenden Sie StyleCop für die Überprüfung des Codierungsstils.
3. Aufgrund der unterschiedlichen Semantik von Werttypen, so dass sie mit einer alternativen Farbe in der IDE liefert (gehen Sie zu Extras/Optionen/Umwelt/Schriftart und Farben/Ausstellungsstück und Benutzertypen (Aufzählungen) und Benutzer liefern Typen (Werttypen) mit einem Wert wie # DF7120 [223, 113, 32]).
4. Da Ausnahmen dazu neigen, Fehler in Ihrem Code anzuzeigen, lassen Sie die IDE bei allen Ausnahmen abbrechen. (Gehen Sie zu Debug/Ausnahmen .../Common Language Runtime Ausnahmen und überprüfen Sie Throw).
5. Projekteinstellungen: Unsafe-Code nicht zulassen.
6. Projekteinstellungen: Bedrohungswarnungen als Fehler.
7. Projekteinstellungen: Auf arithmetischen Überlauf/Unterlauf prüfen.
8. Verwenden Sie Variablen für ein einzelnes, genau definiertes Ziel.
9. Verwenden Sie keine magischen Zahlen.
10. Schreiben Sie kurze Methoden. Eine Methode sollte nur eine Abstraktionsebene enthalten.
11. Eine Methode kann nie zu klein sein (eine Methode von 20 Zeilen wird als ziemlich groß angesehen).
12. Eine Methode sollte sich vor schlechter Eingabe schützen.
13. Überlegen Sie, einen Typ unveränderlich zu machen.
14. Unterdrücken Sie Warnungen in Ihrem Code nicht mit deaktivierter Pragma-Warnung.
15. Kommentieren Sie keinen schlechten Code: schreiben Sie ihn um.
16. Dokument explizit im Code, warum Sie eine Ausnahme verschlucken.
17. Beachten Sie die Auswirkungen von verketteten Zeichenfolgen auf die Leistung.
18. Niemals goto-Anweisungen verwenden.
19. Frühes Versagen, schnelles Versagen.

Answer 4

Ich verwende Microsofts Design Guidelines for Developing Class Libraries. Und ich denke, es ist ziemlich gut, mit zu beginnen.