Quote:
Originally Posted by Fаng
It's extremely important to document your code. You're ignorant if you think that me documenting my code is an ignorant action.
(I don't read these tutorials, but I found this on google which states the reasons why I document my code):
[Only registered and activated users can see links. Click Here To Register...]
|
You're ignorant if you think I was bashing documentation. I'm extremely pro-documentation and it's essential to document everything if you're in a team project.
Here's a snippet of my documentation of a subtype of packet 1010/10010.
/// <summary>
/// Sent client->server when a player requests a teammate's position. Server responds with the requested information.
/// (client->server) entityUID = requestedCharacterUID, ValueD = requestedCharacterUID.
/// (server->client) entityUID = characterUID, ValueA = requestedXcoordinate, ValueB = requestedYcoordinate, ValueD = requestedCharacterUID.
/// </summary>
RequestTeammatePosition = 0xA6,
There's no way in hell I'm going to memorize this or navigate through my code figuring out this information every time I need it, rather than simply putting the information right here in an XML comment. No thank you.