Stilllegung des Forums
Das Forum wurde am 05.06.2023 nach über 20 Jahren stillgelegt (weitere Informationen und ein kleiner Rückblick).
Registrierungen, Anmeldungen und Postings sind nicht mehr möglich. Öffentliche Inhalte sind weiterhin zugänglich.
Das Team von spieleprogrammierer.de bedankt sich bei der Community für die vielen schönen Jahre.
Wenn du eine deutschsprachige Spieleentwickler-Community suchst, schau doch mal im Discord und auf ZFX vorbei!
Werbeanzeige
Zitat
Ich bin nicht der Messias.
Ich sage, du bist es, Herr. Und ich muss es wissen, denn ich bin schon einigen gefolgt.
Zitat
So kommt es vor, dass mir die Dokumentation wie eine (sinnlose) Doppelung der Signatur erscheint
C-/C++-Quelltext |
|
1 2 |
// CollideableGroupGroup does not own g, but only holds a WeakRef to it void CollideableGroupGroup::add(CollideableGroup& g); |
C-/C++-Quelltext |
|
1 2 3 4 |
// Note that only the existence, not the actual readability of the file // is checked. Trying to open a file using PhysFS could be rather // expensive. if (PHYSFS_exists(filename)) /* ... */ |
Wie händelt Ihr das? Welche Reiszwecke muss man sich in den Hintern jagen, damit man ordentlich dokumentiert. Lesestoff, Referenzen und allgemeine Ratschläge nehme ich gerne entgegen.
Es ist ja keine Schande etwas falsch zu machen, als Programmierer tu ich das täglich, [...].
Zitat
public abstract class AbstractSingletonProxyFactoryBean
Convenient proxy factory bean superclass for proxy factory beans that create only singletons.
Community-Fossil
Beruf: Teamleiter Mobile Applikationen & Senior Software Engineer
Solche Dokumentation ist aber für die Tonne, weil sie sogar falsche Sachen behauptet.Als schönes Beispiel für eine Dokumentation dieser Qualität ist auch hier: http://static.springsource.org/spring/do…actoryBean.html
Zitat
public abstract class AbstractSingletonProxyFactoryBean
Convenient proxy factory bean superclass for proxy factory beans that create only singletons.
C#-Quelltext |
|
1 2 3 4 5 6 |
/// <summary> /// Files the exists. /// </summary> /// <param name="fileName">Name of the file.</param> /// <returns></returns> bool FileExists( string fileName ) |
Community-Fossil
Beruf: Teamleiter Mobile Applikationen & Senior Software Engineer
Es ist sogar ein sehr gutes Zeichen, wenn du keine Doku brauchst und der Programmcode selbsterklärend ist.
Werbeanzeige