C#, bin mit Dokumentation unzufrieden

E

epfoot

Banned

Registriert

Okt. 2014

Beiträge

123

• 28. Oktober 2014

• #1

Hallo zusammen,

ich komme mit kleinem Java-Hintergrund und fange derzeit C# an. Was mich aktuell stört ist die Dokumentation von C#. In Java sehe ich die Methode und sofort was für einen Rückgabewert verlangt wird, z. B. einen String bei Path.toString();. Bei C# dagegen sind nur die Methoden aufgelistet und ich kann z. B. aus Path.ChangeExtension(); nicht gleich rauslesen welcher Rückgabewert verlangt wird.

Muss ich damit leben oder gibt es irgendwo eine bessere Doc, Einstellungen auf der MS-Seite?


http://msdn.microsoft.com/de-de/library/system.io.path(v=vs.110).aspx
http://docs.oracle.com/javase/7/docs/api/java/nio/file/Path.html

Grüße

 

Brinox

Lt. Junior Grade

Registriert

Juni 2011

Beiträge

431

• 28. Oktober 2014

• #2

Einfach auf die Methode draufklicken, dann kriegste die Signatur in meist 3-4 Sprachen angezeigt (wie hier). Und: Ja C# ist schlecht dokumentiert, wie alles was Microsoft verzapft.

 

pockic

Ensign

Registriert

Dez. 2006

Beiträge

207

• 28. Oktober 2014

• #3

Klick einfach die Methode bei der Dokumentation an, dort sind alle Parameter und der Rückgabewert erklärt:
http://msdn.microsoft.com/de-de/library/system.io.path.changeextension%28v=vs.110%29.aspx

 

D

Donnidonis

Commander

Registriert

Apr. 2009

Beiträge

2.690

• 28. Oktober 2014

• #4

Brinox, etwas nen Microsoft-Hater?
Ist doch ne gute Doku, hast direkt Code-Beispiele dabei, besser kann es doch nicht sein.

Wie die Anderen sagen, wenn du weißt wonach du suchst, klick die Methode an und du bekommst ein Haufen an Informationen.

 

M

miac

Gast

• 28. Oktober 2014

• #5

Vielleicht auch ein Problem deiner Entwicklungsumgebung.

Sharpdevelop zeigt dir auf F1 direkt die Microsoft Seite.

 

Shio

Captain

Registriert

Okt. 2008

Beiträge

3.440

• 28. Oktober 2014

• #6

Die Doc von MS ist eigentlich echt super.
Fast bei jeder Methode sind Beispiele dabei und es wird immer groß erklärt wie jede Methode funktioniert.
Ansonsten installier dir doch einfach Visual Studio für C#. Ist für Privatanwender kostenlos und hat mit IntelliTrace eine echt gute Oberfläche.

 

E

epfoot

Banned

Ersteller dieses Themas

Registriert

Okt. 2014

Beiträge

123

• 28. Oktober 2014

• #7

ja die code-beispiele finde ich auch sehr gut, wesentlich brauchbarer als die bei java.

aber um die rückgabenwerte rauszubekommen müsste ich an die 100ert mal auf jede einzelne methode verschiedener klassen drücken, sehr aufwändig.

 

C

can320

Gast

• 28. Oktober 2014

• #8

Vielleicht braucht man diese Angaben nicht?

 

TheCadillacMan

Captain

Registriert

Juni 2005

Beiträge

3.091

• 28. Oktober 2014

• #9

Als jemand der regelmäßig C#-Code schreibt und auch Geld dafür kriegt, kann ich dir ein paar Tipps geben:

1) Benutze Visual Studio und IntelliSense. Mit IntelliSense und etwas Erfahrung beim Lesen der Methodennamen kannst du dir 95% der Blicke in die Doku sparen. Die MSDN mache ich nur auf wenn ich genau wissen will wie die Methode funktioniert.
2) Rückgabetypen nicht in der Doku nachschlagen. Meistens ist es aus dem Namen ersichtlich (z. B. ToString()) und wenn nicht schreibe ich zur Not den Aufruf einfach hin (bzw. lasse ihn vervollständigen), fahre mit der Maus drüber und lese den Tooltip. Um zur Doku im Browser zu wechseln brauche ich deutlich länger.
3) Vergiss die deutsche Doku. Die ist nicht unbedingt falsch, aber viele Dinge sind für meinen Geschmack deutlich zu wörtlich übersetzt und manchmal ist einfach nicht verständlich. Ich benutze ausschließlich die zum Großteil sehr gute englische MSDN.

Das ist zumindest mein Workflow. Andere Leute machen es anders und er erfordert zugegeben etwas Erfahrung. Letztendlich kommt es aber nur darauf an was du für dich als ausreichend produktiv empfindest.

 

E

epfoot

Banned

Ersteller dieses Themas

Registriert

Okt. 2014

Beiträge

123

• 28. Oktober 2014

• #10

@can320
ich finde schon. wie soll man auf die idee kommen, dass "DirectoryInfo.GetFiles" eine "FileInfo" zurückliefert und man mit der klasse "FileInfo" nun ganz viele weitere möglichkeiten hat.

das bekommt man eben erst raus, wenn man googlet oder alle methoden mal durchklickt.

@TheCadillacMan
danke für die tipps

 

D

Donnidonis

Commander

Registriert

Apr. 2009

Beiträge

2.690

• 28. Oktober 2014

• #11

Wenn du dir Visual Studio holst, dann Path. eingibst schreibt er doch bei jede Methode direkt dabei was zurück geliefert wird.
So ist ein Blick in jegliche Doku doch unnötig.

 

iks-deh

Lt. Commander

Registriert

Jan. 2011

Beiträge

1.325

• 28. Oktober 2014

• #12

Ich drück immer auf F12, dann komm ich zur Methodendefinition bei der man auch gleich den Rückgabetyp sieht (da kann man dann mit F12 auch gleich zur Definition springen).

 

I

IKäsebrot

Ensign

Registriert

Juni 2014

Beiträge

245

• 29. Oktober 2014

• #13

iks-deh schrieb:

Ich drück immer auf F12, dann komm ich zur Methodendefinition bei der man auch gleich den Rückgabetyp sieht (da kann man dann mit F12 auch gleich zur Definition springen).

Zum Vergrößern anklicken....

F12 war ein super Tipp, kannte ich garnicht, danke!

 

Yuuri

Fleet Admiral

Registriert

Okt. 2010

Beiträge

13.923

• 29. Oktober 2014

• #14

epfoot schrieb:

ich finde schon. wie soll man auf die idee kommen, dass "DirectoryInfo.GetFiles" eine "FileInfo" zurückliefert und man mit der klasse "FileInfo" nun ganz viele weitere möglichkeiten hat.

Zum Vergrößern anklicken....

Du suchst an der falschen Stelle bzw. hast dir die falsche Methode dafür rausgesucht.

DirectoryInfo.GetFiles gibt dir FileInfo[] zurück
Directory.GetFiles gibt dir string[] zurück

Dein gewünschter Aufruf liegt wohl eher in der zweiten Methode. Also - richtige Funktion nutzen und nicht die, wo man denkt, dass es die Richtige ist. Übrigens ist die Methode EnumerateFiles besser.

 

M

max_1234

Captain

Registriert

Feb. 2012

Beiträge

3.682

• 3. November 2014

• #15

Gerade C# .NET ist die am Besten dokumentierte Sprache.
Mit Visual Studio bekommst du beim Implementieren in Echtzeit benötigte Parameter sowie Methodenbeschreibungen angezeigt.

mfg,
Max