In diesem Thread wollte ich euch mal aufmerksam machen auf was ihr achtent müsst wenn ihr fester Entwickler dieses Team seit (Contributor brauchen sich da nicht so einen kopf zu machen da wir das ähnlich wie JEDI regeln, Entwickler aus unserem Team passen den Code an unsere Standards an).
1. Code Style
Wir haben einen einheitlichen Code Style an den sich bitte zu halten ist. Schließlich wollen wir das mehrere Entwickler eine Datei bearbeiten können.
Wir verwenden den auf folgender Seite vorgestellten Code Style:
http://www.sharpdevelop.com/TechNotes/SharpDevelopCodingStyle03.pdf
2. Kommentare
Todo und Bug einträge sind im Code sehr wichtig damit andere Entwickler auf Fehler hingewiesen werden und oder ein neues Feature hinzufügen können.
Beim TODO/Bug Eintrag bitte auch Name des Entwicklers dazu.
3. Header
Im Nachfolgenden ist der Header abgebildet der als Template für JEDE Datei genutzt werden muss:
Zitat |
#region myCSHARP Library // ----------------------------------------------------------------------------- // The contents of this file are subject to the GNU Lesser General Public Licens // (the "License"); you may not use this file except in compliance // with the License. You may obtain a copy of the License at // http://www.gnu.org/copyleft/lesser.html // // Software distributed under the License is distributed on an "AS IS" basis, // WITHOUT WARRANTY OF ANY KIND, either expressed or implied. See the License for // the specific language governing rights and limitations under the License. // // Copyright 2005 - myCSHARP Team - All Rights Reserved. // Authors: // - Name of Author <Email@email.de> // // Contributors: none // // Known Issues: // - None // // You may retrieve the latest version of this file at the myCSHARP // home page, located at http://mycsharp.sourceforge.net // //------------------------------------------------------------------------------------ // Version: 0.0 // Description: A short description of what the file do //------------------------------------------------------------------------------------ #endregion |
4. Namespaces (bei Komponenten mit mehreren Klassen am besten ein Unterverzeichnis anlegen)
mycsharp.Core
mycsharp.Math
mycsharp.GUI
mycsharp.Net
mycsharp.IO
mycsharp.XML
mycsharp.Security
mycsharp.System
mycsharp.Media
mycsharp.Media.Graphics
mycsharp.Media.Audio
mycsharp.Misc
mycsharp.Text
mycsharp.Database
mycsharp.Diagnostics
Falls ihr nicht wisst, in welche Kategorie ihr eure Komponenten einordnen sollt, fragt vorher am besten im Forum nach!
5. Verwendete Sprache
Alle Methoden, Klassen, Variablen und Kommentare die nach aussen zu sehen sind, bitte auf Englisch.
Bei Kommentaren kann man noch ein Auge zu drücken bei dem restlichen nicht!
Ansonsten nach all den regeln wünsche ich jedem viel Spass!!!!
von cYaONE: Hab noch Namespaces als 4. Regel aufgeführt, ich hoffe, ihr seit damit einverstanden
von VizOne: Ich habe mir erlaubt aus "Standarts" und "Standarte" "Standards" zu machen, da ich glaube, dass es hier weniger um Stand-arten oder Standarten geht