none
Wie beizeichne ich die einzelnen Dateien in meinem Projekt? RRS feed

  • Frage

  • Hallo,

    ich bin noch recht neu in der Visual Studio Welt. Vorher habe ich viel in VBA programmiert. Die objektorientierte Programmierung ist mir aber nicht fremd.

    Ich habe jetzt mein erstes Projekt angefangen und beschäftige mich gerade mit "Naming conventions" in VB.net. In meinem Projekt habe ich mehrere Dateien (Klassen, Formulare und Codemodule). Die Frage, die ich mir gerade stelle:

    Wie benenne ich die einzelnen Dateien (*.vb) "korrekt", so dass ich a) gut erkennen kann, was diese Datei beinhaltet und b) ich auch nach 50 Dateien noch einen Überblick habe. Wenn ich in den Projektmappen-Explorer schaue, dann sind alle .vb Dateien direkt unter dem Projekt eingehängt. Sowas wie eine Ordnerstruktur konnte ich da nicht anlegen.

    LG, CNX

    Freitag, 11. Juni 2010 13:34

Antworten

  • Hallo,

    Ich habe jetzt mein erstes Projekt angefangen und beschäftige mich gerade mit "Naming conventions" in VB.net. In meinem Projekt habe ich mehrere Dateien (Klassen, Formulare und Codemodule). Die Frage, die ich mir gerade stelle:

    Wie benenne ich die einzelnen Dateien (*.vb) "korrekt", so dass ich a) gut erkennen kann, was diese Datei beinhaltet und b) ich auch nach 50 Dateien noch einen Überblick habe. Wenn ich in den Projektmappen-Explorer schaue, dann sind alle .vb Dateien direkt unter dem Projekt eingehängt.

    Grundlegende Namenskonventionen des .NET Framwork kannst Du folgenden Richtlinien entnehmen:

    Design Guidelines for Developing Class Libraries
    http://msdn.microsoft.com/en-us/library/ms229042.aspx

    Die sind nicht nur bei der Entwicklung von Klassenbibliotheken interessant, sondern können allgemein zur Entwicklung von Anwendungen angewandt werden.

    Die Codedateien werden in der Regel so benannt, wie die Klassen, die in ihnen enthalten sind. Dabei gilt die Empfehlung, pro Codedatei eine Klasse, es sei denn es handelt sich um geschachtelte Klassen oder wie bei Designer, Klassen, die einen automatisch verwalteten Part haben, wie einen selbst kontrollierten. Um im Projekt und auch in der Projektmappe den Überblick zu behalten, ist es hilfreich mit Namespaces zu arbeiten. Dabei organisiert man die Dateien in entsprechenden Unterordnern, die nach dem Namespace der Klasse benannt sind. Es bleibt dabei Dir überlassen, ob Du diese nun flach organisierst oder verschachtelst:

    Bsp. flach:
    MyProject
       Utilities.Foo
       Utilities.Bar

    Bsp. verschachtelt:
    MyProject
      Utilities
         Foo
      Utilities
         Bar

    Beide Varianten haben ihre vor und Nachteile.

    Auf Präfixe, wie 'cls' oder 'frm' solltest Du nach Möglichkeit verzichten. Ich denke durch die sinnvolle Anwendung von Namespaces und entsprechenden Ordnern, lässt sich ein Projekt weit besser organisieren.

    Thorsten Dörfler
    Microsoft MVP Visual Basic
    Freitag, 11. Juni 2010 17:46

Alle Antworten

  • Hallo CNX,

    Ordner kannst Du anlegen: Rechte-Maus auf den Projekt-Eintrag im Solution Explorer => Hinzufügen => "Neuer Ordner".
    Geht selbst in der Express Edition.


    Olaf Helper ----------- * cogito ergo sum * errare humanum est * quote erat demonstrandum * Wenn ich denke, ist das ein Fehler und das beweise ich täglich http://olafhelper.over-blog.de
    Freitag, 11. Juni 2010 14:04
  • Hallo,

    Ich habe jetzt mein erstes Projekt angefangen und beschäftige mich gerade mit "Naming conventions" in VB.net. In meinem Projekt habe ich mehrere Dateien (Klassen, Formulare und Codemodule). Die Frage, die ich mir gerade stelle:

    Wie benenne ich die einzelnen Dateien (*.vb) "korrekt", so dass ich a) gut erkennen kann, was diese Datei beinhaltet und b) ich auch nach 50 Dateien noch einen Überblick habe. Wenn ich in den Projektmappen-Explorer schaue, dann sind alle .vb Dateien direkt unter dem Projekt eingehängt.

    Grundlegende Namenskonventionen des .NET Framwork kannst Du folgenden Richtlinien entnehmen:

    Design Guidelines for Developing Class Libraries
    http://msdn.microsoft.com/en-us/library/ms229042.aspx

    Die sind nicht nur bei der Entwicklung von Klassenbibliotheken interessant, sondern können allgemein zur Entwicklung von Anwendungen angewandt werden.

    Die Codedateien werden in der Regel so benannt, wie die Klassen, die in ihnen enthalten sind. Dabei gilt die Empfehlung, pro Codedatei eine Klasse, es sei denn es handelt sich um geschachtelte Klassen oder wie bei Designer, Klassen, die einen automatisch verwalteten Part haben, wie einen selbst kontrollierten. Um im Projekt und auch in der Projektmappe den Überblick zu behalten, ist es hilfreich mit Namespaces zu arbeiten. Dabei organisiert man die Dateien in entsprechenden Unterordnern, die nach dem Namespace der Klasse benannt sind. Es bleibt dabei Dir überlassen, ob Du diese nun flach organisierst oder verschachtelst:

    Bsp. flach:
    MyProject
       Utilities.Foo
       Utilities.Bar

    Bsp. verschachtelt:
    MyProject
      Utilities
         Foo
      Utilities
         Bar

    Beide Varianten haben ihre vor und Nachteile.

    Auf Präfixe, wie 'cls' oder 'frm' solltest Du nach Möglichkeit verzichten. Ich denke durch die sinnvolle Anwendung von Namespaces und entsprechenden Ordnern, lässt sich ein Projekt weit besser organisieren.

    Thorsten Dörfler
    Microsoft MVP Visual Basic
    Freitag, 11. Juni 2010 17:46
  • Vielen Dank für die Antworten. Ich werde es mal mit einer verschachtelten Struktur ausproblieren.
    Montag, 14. Juni 2010 14:01