Wie kommentiert ihr?
Verfasst: 18.03.2009, 16:21
Jetzt muss ich doch mal glatt aufn Klammerthread fragen wie ihr eigentlich kommentiert.
Ich mach das immer so, sofern ich nicht mit Doxygen arbeite:
Arbeite ich mit Doxygen kommentiere ich so:
Einige Fälle möchte ich aus Vielseitigkeit jetzt nicht weiter zeigen. Es gibt auf jeden fall mehr Situationen.
Und wie schaut es bei euch aus? Schreibt ihr in Deutsch oder Englisch? Beachtet ihr die 90 Zeichen pro Zeile maximal zum Ausdrucken? :?:
Ich mach das immer so, sofern ich nicht mit Doxygen arbeite:
Code: Alles auswählen
// BS Engine 4 Game Library
namespace BSE4
{
// Handles a DirectX 10 device
class Device
{
// Creates a device
const BSError Create(const BSE4Struct::DeviceConfigDesc &CDesc, // The config desc
const HWND hWnd /* Handle to a window */ );
}
}
Code: Alles auswählen
/*! @namespace BSE4
@brief BS Engine 4 Game Library */
namespace BSE4
{
/*! @class Device
@brief Handles a DirectX 10 device */
class Device
{
/*! @brief Creates a device
@param CDesc is a configuration desc by BSE4Struct::DeviceConfigDesc
@param hWnd is a handle to a window from a windows Win32 application */
const BSError Create(const BSE4Struct::DeviceConfigDesc &CDesc,
const HWND hWnd );
}
}
Code: Alles auswählen
...
// Create simple terrain grid
for(...)
for(...)
...
/* Here is something to note:
- ...
*/
...
Und wie schaut es bei euch aus? Schreibt ihr in Deutsch oder Englisch? Beachtet ihr die 90 Zeichen pro Zeile maximal zum Ausdrucken? :?: