C# - Wie schreibt man private variablen richtig?

Hallo Leute,

In Java schreibt man ja private variablen klein und ohne unterstrich

Beispiel:

private String guteFrage;

Aber wie Schreibt man den jetzt private variablen in C#? Habe jetzt 2 Sachen gesehen wie man es machen könnte

private string guteFrage; // einfach sowie in Java

private string _guteFrage;

Also meine Frage, wie schreibt man den jetzt Private Variablen in C# richtig?

4 Antworten

regex9

Von gutefrage auf Grund seines Wissens auf einem Fachgebiet ausgezeichneter Nutzer

Computer, programmieren, C Sharp

26.05.2020, 19:39

Wenn du mit einem Tool wie ReSharper arbeitest, wirst du bei Bezeichnern schnell darauf hingewiesen, dass nach Konvention private Felder mit einem führenden Unterstrich beginnen:

private int _someField;

und nur statische Felder mit konstanten Werten eine Ausnahme bilden:

private const int SomeField = 1;
private static readonly int SomeOtherField = 2;

Dabei richtet sich das Tool laut diesem Artikel standardmäßig nach den Microsoft Guidelines.

In diesen lässt sich allerdings keine Vorgabe für private Felder finden. Nur dies:

The field-naming guidelines apply to static public and protected fields. Internal and private fields are not covered by guidelines, and public or protected instance fields are not allowed by the member design guidelines.

✔️ DO use PascalCasing in field names.

✔️ DO name fields using a noun, noun phrase, or adjective.

❌ DO NOT use a prefix for field names.

For example, do not use "g_" or "s_" to indicate static fields.

Microsoft Design Guidelines

(Weitere Guidelines zu C# / .NET findest du übrigens hier).

Weiterhin spricht man sich in den generellen Namenskonventionen gegen Unterstriche in Bezeichnern aus:

❌ DO NOT use underscores, hyphens, or any other nonalphanumeric characters.

und bei Verwendung eines MS Tools wie StyleCop würden führende Unterstriche ebenfalls als Verstoß angemerkt werden.

All dem widersprechen wiederum die Konventionen, auf die sich das Team für das .NET-Subprojekt CoreFX geeinigt hat:

We use _camelCase for internal and private fields and use readonly where possible. Prefix instance fields with _, static fields with s_ and thread static fields with t_. When used on static fields, readonly should come after static (i.e. static readonly not readonly static).

Quelle

Du merkst: Von offizieller Seite gibt es keine eindeutige Vorgabe, wie private Felder aussehen sollen und hinzu kommen unterschiedliche Ansichten bezüglich des Unterstrichs (der ursprünglich übrigens seinen Ursprung aus C++ haben sollte und in einer Sprache wie Dart sogar Bestandteil der Syntax ist).

Meiner Erfahrung nach ist die Verwendung des führenden Unterstrichs unter C#-Entwicklern weit verbreitet. Ich selbst bevorzuge sie.

Ob du dich dieser Konvention anschließt oder es so, wie in Java machst, ist also deine Entscheidung (bzw. solltest du mit den Entwicklern abstimmen, mit denen du womöglich zusammenarbeitest). Eine Pflicht ist der Unterstrich jedenfalls nicht.

Isendrak

Von gutefrage auf Grund seines Wissens auf einem Fachgebiet ausgezeichneter Nutzer

programmieren

26.05.2020, 12:29

Technisch gesehen:

Vollkommen egal. Du könntest auch

private string Gu_Te_FrA_gE;

schreiben, wenns dir gefällt.

Allerdings gibt es gewisse Konventionen (also "wie es üblich ist"-Dinge), und da sind im Grunde beide von dir erwähnten Schreibweisen "korrekt".

P.S.: Ich persönlich würde trotzdem die Schreibweise ohne Unterstrich vorziehen, ausser in Fällen in denen es mit "notwendig" ist.

Dultus, UserMod Light

Von gutefrage auf Grund seines Wissens auf einem Fachgebiet ausgezeichneter Nutzer

Computer, programmieren, C Sharp

26.05.2020, 12:05

Moin,

das mit dem Unterstrich ist nur eine Schreibweise, wie man auch gerne

bBool oder iInt schreibt.

Kannst also beides nach Bedarf nutzen und haben nichts mit der Funktionalität zu tun.

Woher ich das weiß:Berufserfahrung – 💻 Zertifizierter Sr. Cloud Engineer im IT-Consulting

Palladin007

Von gutefrage auf Grund seines Wissens auf einem Fachgebiet ausgezeichneter Nutzer

Computer, programmieren, C Sharp

26.05.2020, 19:04

Das bleibt jedem selbst überlassen und ist eine Frage des Geschmacks.

Die Guideline von Microsoft und die allermeisten C#-Entwickler sind sich aber einig: Variante 2

Außerdem sollte keine einzige Klassenvariable jemals nicht private sein, dafür gibt es Properties.

Woher ich das weiß:Berufserfahrung – C#.NET Senior Softwareentwickler

regex9

26.05.2020, 19:42

Die Guideline von Microsoft (...)

Kannst du auf die konkrete Stelle bitte einmal verlinken? Ich habe eben noch selbst diesbezüglich gesucht, bin aber nicht fündig geworden.

Palladin007

26.05.2020, 20:02

@regex9

Da muss ich zugeben: Ich hab sie nie gelesen :D

Ich hab vor Jahren Mal eine Guideline meiner damaligen Firma gelesen, die wurde damals auf der Grundlage von Microsoft erstellt und für die eigenen Anforderungen angepasst.
Außerdem hab ich sehr oft gelesen, dass MS das so empfiehlt, selber gelesen habe ich es aber nie.

Aus irgendeinem Grund sind sich da aber die allermeisten C#-Entwickler einig, eine andere Erklärung, als eine (ehemalige) Guideline von Microsoft hab ich nicht.

So auf die Schnelle hab ich mehrere MSDN-Artikel zu dem Thema gefunden, aber nichts zum Thema globaler Variablen, keine Ahnung, warum nicht.

Palladin007

26.05.2020, 20:07

@regex9

PS:

https://en.wikipedia.org/wiki/Naming_convention_(programming)#C.23

The most common practice is to use PascalCase for the names of all fields, except for those which are private (and neither const nor static), which are given names that use camelCase preceded by a single underscore; for example, _totalCount.

Vielleicht stand das Mal in der Guideline und sie haben es aus irgendeinem Grund entfernt.

regex9

26.05.2020, 21:18

@Palladin007

Das glaube ich auch. Das würde erklären, wieso auch ReSharper diese Konvention bei sich integriert hat.

Palladin007

26.05.2020, 21:53

@regex9

Dann frage ich mich, wieso sie das entfernt haben?

Die Community führt es ja mehrheitlich weiter.

Interessant ist dabei auch, dass der alte Code von Microsoft meist mit "m_" beginnt, bei neuem Code (am Beispiel vom Immutable-Namespace) ist es aber nur der Unterstrich.

regex9

27.05.2020, 09:29

@Palladin007

Da spielt einiges an Geschichte / Verlauf technischer Entwicklung hinein.

Charles Simonyi galt als Begründer der ungarischen Notation, die ursprünglich konkret für die Programmiersprache BCPL entwickelt wurde. In den 70er Jahren baute Simonyi noch für das Unternehmen Xerox PARC an Software, die auf BCPL basierte. Später (in den 80ern) wechselte er zu Microsoft und war an dem Entwicklungsprozess der Office-Software (Excel, Word, ...) beteiligt. In diesem Zuge führte er auch seinen Style-Guide ein, der sich generell schnell verbreitete und z.B. auch Anwendung für VB oder die Windows API fand. Allerdings kam es dabei auch zu Missinterpretationen dieser Konvention und das war letztendlich einer der Auslöser, wieso die ungarische Notation so negativ betrachtet wird.

Die m_-Notation ist jedenfalls Teil der ungarischen Konvention / dieses Style Guides. Siehe beispielsweise in den Styleguide für die Windows API.

Ein anderer Grund für die Verbreitung wird der Entwicklungsstand von Entwicklungsumgebungen / Editoren gewesen sein. Heute gibt dir die IDE via Syntax Highlighting, Hovering, etc. massenweise Informationen, wie Element für Element zu interpretieren sind und welchen Typ man vorliegen hat. Damals war man noch nicht soweit und so behalf man sich mit solchen Konzepten.

Gehalten hat sich die Notationsweise dann lediglich noch über Gewohnheitstierchen und das generelle Problem, dass der Code nun mal schon geschrieben war. Code Refactoring z.B. für die Windows API kannst du nicht so einfach bringen. 😁

Aber inzwischen hat sich ja einiges getan. Zum einen hat sich Visual Studio immer weiter entwickelt. Zum anderen war gerade Hejlsberg ja viel an einem konsistenten .NET Framework gelegen und die langwierig ausgeknobelten Entscheidungen wurden später von Cwalina und Abrams in Framework Design Guidelines (2005) zusammengefasst. Das sollte eines der einschneidensten Werke gewesen sein, nur drei Jahre später hat R. C. Martin mit Clean Code nachgelegt. Beide Werke richten sich gegen die ungarische Notation.

Zu dem führenden Unterstrich: Sein tatsächlicher Ursprung rührt daher, dass damit Elemente gekennzeichnet werden sollten, die nicht öffentlich zur Verfügung stehen / keine Relevanz nach außen haben, also interne Elemente sind. Ein gutes Beispiel noch heute (in C#): Ungenutzte Variablen werden von Resharper angekreidet, außer, man benennt sie nur mit einem Unterstrich. Da Microsoft viele C++-Entwickler hat, dürfte von ihnen dieser Einfluss herrühren und generell wird er ja fortgeführt / auch in anderen Sprachen genutzt. In Scala oder Clojure finden sich z.B. solche Vorgehensweisen (Unterstrich wird ignoriert). Python verwendet gern führende Unterstriche für Elemente, auf die kein Zugriff bestehen soll und setzt teilweise sogar mehrere führende Unterstriche ein.

Wieso Microsoft den Punkt zu privaten Feldern ausgelassen hat, verstehe ich auch nicht. Vielleicht war es ein zu großer (interner) Streitpunkt.

Ähnliche Beiträge

Java - Warum sollte man final auf variablen anwenden?

Hallo Leute,

Warum sollte man final auf variablen anwenden? Z.b wo ist der unterschied zwischen:

public final String gutefrage = "";

und

public String gutefrage = "";

...zum Beitrag

C# kann Variable in der selben Klasse nicht benutzen?

Moin,

Bin grad dran einen Launcher zu erstellen und hab eine Funktion gemacht womit man eine Exe Datei wählen kann die als String Variable namens filePath gespeichert wird, wenn ich diese rufen will damit der Launch Button weiß was er starten soll bekomme ich den Error "Der Name "filePath" ist im aktuellen Kontext nicht vorhanden."

Wie kann ich hin bekommen das die Variable von der gesamten Klasse verwendet werden kann?

Code in Frage:

        private void button8_Click(object sender, EventArgs e)
        {
            using (OpenFileDialog openFileDialog = new OpenFileDialog())
            {
                openFileDialog.InitialDirectory = "c:\\";
                openFileDialog.Filter = "Exe Files (.exe)|*.exe"; ;
                openFileDialog.FilterIndex = 2;
                openFileDialog.RestoreDirectory = true;


                if (openFileDialog.ShowDialog() == DialogResult.OK)
                {
                    String filePath = openFileDialog.FileName;
                    textBox1.Text = filePath;
                }
            }
        }


        private void button7_Click(object sender, EventArgs e)
        {
            string WindowsUser = Environment.UserName;
            string GameName = "Game";
            System.Diagnostics.Process.Start($@"C:\Users\{WindowsUser}\AppData\Local\{GameName}\Saved\SaveGames.");
        }


        private void button1_Click(object sender, EventArgs e)
        {
            System.Diagnostics.Process.Start($"{filePath}");
        }
    }
}

...zum Beitrag

Probleme beim Kompilieren in C++ (Nicht definierter Verweis) , kann mir einer helfen?

Hey Leute, ich bin noch recht neu in C++ und wollte eine Klasse erstellen. Beim Kompilieren jedoch ensteht jedes Mal der selbe Fehler. Im folgenden meine Dateien:

//Variables.h

#include <string>

class Variables{

private: 

    std::string name;

public:

    Variables();
    ~Variables();

    void setName(std::string n);

    std::string getName();
    
};

//Variables.cpp

#include <string>
#include <iostream>

#include "Variables.h"


Variables::Variables(){
    std::cout << "Konstr" << std::endl;
}

Variables::~Variables(){
    coutstd:: << "Destr" << std::endl;
}


void Variables::setName(std::string n){
    name = n;
}

std::string Variables::getName(){
    return name;
}

//test.cpp

#include <iostream>
#include <string>

#include "Variables.h"

using namespace std;


int main(){

        Variables v1;
        v1.setName("keks");

        cout << v1.getName() << endl;

}

Die Fehlermeldung ist:

/tmp/ccEemOw1.o: In Funktion main': test.cpp:(.text+0x11): Nicht definierter Verweis aufVariables::Variables()' test.cpp:(.text+0x45): Nicht definierter Verweis auf Variables::setName(std::string)' test.cpp:(.text+0x70): Nicht definierter Verweis aufVariables::getName()' test.cpp:(.text+0xa6): Nicht definierter Verweis auf Variables::~Variables()' test.cpp:(.text+0xef): Nicht definierter Verweis aufVariables::~Variables()' collect2: error: ld returned 1 exit status

...zum Beitrag

C# bzw OOP - Wo Klassenvariablen definieren?

Hallo,

ich frage mich, wo es am meisten Sinn machen würde, Variablen zu definieren, deren Wert immer derselbe ist.

Beispiel:

Ich habe eine Klasse, die in einigen ihrer Methoden einen Pfad zu einer Datei braucht. Dieser Pfad ist immer derselbe. Kann man diese Variable dann wie folgt definieren?

public class MyClass {
  private String path = "F:\Bilder\Urlaub\Bild1.jpg";
  private int num;

  // etc.
}

Oder ist das schlechter Stil, bzw. kann man etwas ähnliches wie defines anlegen?

Danke im Voraus.

...zum Beitrag

Kann man chars in Java etwa nicht zusammenfügen wie strings?

also würde gerne einzelne Buchstabe an eine leere char Variable hinzufügen bei strings geht das ja mit str.substring und so weiter aber bei chars dachte ich ich mach halt mit str.charAt() und das füg ich dann da dran aber scheinbar geht das net wieso?

Mit freundlichen Grüßen

...zum Beitrag

String in Parameter übergeben klappt nicht Java?

Ich mache einen Online Kurs für Java. Die Aufgabenstellung lautet:

Ergänze in der Klasse Papagei die Methode “sprich”. Diese Methode soll nichts zurückgeben (void) und einen String als Parameter entgegennehmen. Der übergebene String soll zwei mal hintereinander (in zwei separaten Zeilen) ausgegeben werden.

Meine Lösung lautete

 class Papagei {
    public void sprich(String aussage){
        System.out.print.ln(aussage);
        System.out.print.ln(aussage);
    }
    
    
    public static void main(String[] args) {
        Papagei alex = new Papagei();
        alex.sprich("Hallo");
    }
}

Resultat:

error: cannot find symbol
        System.out.print.ln(aussage);
                  ^
  symbol:   variable print
  location: variable out of type PrintStream
1 error
make: * [run] Error 1

Ich weiß nicht was ich falsch gemacht habe.

...zum Beitrag

Wie sieht die Punktnotation in Java aus oder wie kann ich auf auf andere Klassen zugreifen?

Wie kann ich in der Klasse Telefon die Methoden aus der Klasse Telefonbuch verwenden ? Wenn ich es mit Punktnotation versuche wie z.B.

public void eintrag_hinzufuegen(String name)
{
    Telefonbuch.hinzufuegen(name);
}

, kommt die Fehlermeldung : non static method cannot be referenced from a static context

import java.util.ArrayList;
public class Telefon
{
protected ArrayList <Telefonbuch> telefonbuch;
protected boolean eingeschaltet;
        
        public Telefon()
    {
        // initialise instance variables
        telefonbuch = new ArrayList <Telefonbuch>();
    }
    
    public void anrufen (String name)
    {
    }
    
    public void einschalten()
    {
        eingeschaltet = true;
    }
    
    public void telefonbuch_uebersicht()
    {
        
    }
    
    public void eintrag_hinzufuegen(String name)
    {
    }
    
    public void eintrag_entfernen(String name)
    {
    }
    
    public boolean eintrag_suchen(String name)
    {
    }
}

import java.util.Arrays;

/**
 * Write a description of class Telefonbuch here.
 * 
 * @author (your name) 
 * @version (a version number or a date)
 */
public class Telefonbuch
{
    // instance variables - replace the example below with your own
    private int anzahl_eintrag;
    private int kapazitaet;
    private String[] name_liste;
    protected boolean gefunden;

    /**
     * Constructor for objects of class Telefonbuch
     */
    public Telefonbuch()
    {
        // initialise instance variables
        String [] name_liste = new String[kapazitaet];
        gefunden = false;
    }
    
    public void set_kapazitaet(int x)
    {
        kapazitaet = x;
    }
    
    public void telefonbuch_uebersicht()
    {
        for(int i=0; i < name_liste.length; i++)
        {
        System.out.println(name_liste[i]);
        }
    }
    
    public void hinzufuegen(String name)
    {
        
    }
    
    public void entfernen(String name)
    {
    }
    
    public boolean suchen(String name)
    {
        for(int i=0; i < name_liste.length; i++)
        {
         if(name_liste[i].equals(name))
         {
         gefunden = true;
         }
         else
         {
         //Abbruch
         }
        }
        return gefunden;
    }
}

...zum Beitrag

Unterschied zwischen Instanzmethoden, Klassenmethoden und normalen Methoden, sowie Variablen, Instanzvariablen, Klassenvariablen und Konstruktoren?Java?

Was ist der Unterschied von:

Instanzmethoden

Klassenmethoden

normalen Methoden

Variablen

Instanzvariablen

Klassenvariablen

Konstruktoren ?

Und in was für einer Verbindung stehen die mit public, static und private? Ich habe im Internet mich belesen, aber das nie zusammen gefunden, weshalb das mich doch sehr verwirrt.

Würde mich über eine Antwort freuen

...zum Beitrag

Werden Klassen, Packages, Methoden und Variablen in Java immer kleingeschrieben?

Die Methoden fangen bei mir immer mit einem kleinen Buchstaben an und jedes weitere Wort, das in dem Namen steckt, wird großgeschrieben. Z. B.: meineCooleMethode();

Alle Klassen und Packages dann etwa so: MeineCooleKlasse/MeinCoolerOrdner

Das Problem ist jetzt, dass ich viele Methoden habe, die den selben Namen wie die Klasse haben. Beispiel:

import ....MeinCoolderOrdner.MeineCooleSache;

public void meineCooleSache(String string){
new MeineCooleSache(string);
}

Sollte das fehlerhaft sein, wie sollte ich sowas dann benennen?

...zum Beitrag

C++ Eingabe: Name, Ausgabe: Wert der Variablen mit diesem Namen?

Der Benutzer gibt einen String ein, zum Beispiel: "Hallo." Ich habe auch eine Variable string Hallo = "Tschüss."

Wenn der Nutzer Hallo eingibt, soll Tschüss zurückgegeben werden, wenn er etwas anderes eingibt, soll nichts zurückgegeben werden.

Wie geht das?

...zum Beitrag

Methode IOTools.readline Java Eclipse?

Guten Abend.

Ich habe mal wieder eine Frage über Java.

Ich habe ein Programm mit der main-Methode erstellt, einen String.

Dieses:

public class Hello {
  public static void main(String[] args) {
    String name = "Bsp";
    String x = name;
    System.out.println("Hallo " + x + "!");
  }
}

Diesen soll ich jetzt so umändern, dass anstelle der direkten Zuweisung meines Namens, die Variable mit Hilfe der Methode IOTools.readLine den Wert belegt.

Den Anfang habe ich schon gemacht:

import Prog1Tools.IOTools;

public class Hello {
  public static void main(String[] args) {
    IOTools.readLine();

Jedoch weiß ich nicht weiter. Dokumentationen lesen bringt mir da auch nicht viel, leider.

Ich hoffe ich bekomme hier Hilfe.

...zum Beitrag

Java: readDouble-Methode?

Moin,

folgender Code funktioniert nicht:

public class In {
  public static void main(String[] args) {
    System.out.println(readDouble(" "));
  }

  private static double[] readDouble(String string) {
    return readDouble(" ");
  }
}

Ich bin Anfänger und habe bisher nur die Scanner-Methode benutzt.

Fehlercode (in Zeile 10):

Exception in thread "main" java.lang.StackOverflowError

MfG L

...zum Beitrag

Java: Erstes Wort aus String in anderem String speichern?

Ich habe in Java einen String "MyCoolString" der als Wert einen Satz hat. "Dieser Satz ist der Wert eines Strings!" Ich möchte dass das erste Wort aus dem String MyCoolString,(Trennzeichen ist ein Leerzeichen) in dem String "data" gespeichert wird. In meinem Beispiel müsste der Wert von data am Ende "Dieser" sein. Danke im Voraus!

...zum Beitrag

Hilfe bei Java Grundlagen?

Ich bin bei den Grundlagen von Java. Ich kann zwar kleine Probleme gut lösen, zum Beispiel einzelne Methoden, aber mir fällt das Grundgerüst in Java schwer, insbesondere wenn mehrere Klassen zusammenhängen. Z.b kann man Variablen auch mit einem Klassennamen deklarieren, statt mit einem einfachen Datentypen wie int oder String. Auch die Erzeugung eines neuen Objekts mit new bereitet mir Schwierigkeiten.

Das ganze Konzept soll doch eigentlich dazu dienen, alles übersichtlich zu machen. Für mich wirkt es jedoch aktuell ziemlich durcheinander.

Kann mich jemand aufklären? Vielleicht an einem Beispiel?

...zum Beitrag

Was möchtest Du wissen?

Deinen Beitrag erstellen