Laden...

Standards für das Projekt [Update: 03.04.2005]

Erstellt von Nostalb vor 18 Jahren Letzter Beitrag vor 18 Jahren 11.238 Views
N
Nostalb Themenstarter:in
118 Beiträge seit 2004
vor 18 Jahren
Standards für das Projekt [Update: 03.04.2005]

Hallo,

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

  1. 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.

  2. Header
    Im Nachfolgenden ist der Header abgebildet der als Template für JEDE Datei genutzt werden muss:

#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
//
>

//
// 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
>

//
//------------------------------------------------------------------------------------
// Version: 0.0
// Description: A short description of what the file do
//------------------------------------------------------------------------------------

#endregion

  1. 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!

  1. 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 😉

S
709 Beiträge seit 2005
vor 18 Jahren

Wie meinst du "Sticky"?

1.549 Beiträge seit 2004
vor 18 Jahren

Ich glaube er möchte das der beitrg als wichtig hier im forum gelten soll und als solcher immer oben angezeit werden solte wäre ich auch dafür dann findet man in scheller wenn man ihn sucht

Wir Arbeiten eigendlich nicht wir nehmen nur das geld

2.217 Beiträge seit 2003
vor 18 Jahren

Mädles... der Thread ist doch Sticky.

[EDIT=herbivore vom 22.08.2008]Jetzt nicht mehr 🙂[/EDIT]

Viele Grüße
Alexander

2.921 Beiträge seit 2005
vor 18 Jahren

Ich fände noch wichtig bei Controls zwischen Runtime und Designtime zu unterscheiden. Design-Time Controls sind dann diejenigen die man auch so im Editor einstellen kann, wie eben die Elemente die schon dabei sind und direkt im Design-Editor schon voreinstellen kann usw. z.B. wie ein button oder ein Label.

Seit der Erkenntnis, dass der Mensch eine Nachricht ist, erweist sich seine körperliche Existenzform als überflüssig.