Documenting code for dummies

Mike van Riel (19.Nov.2013 at 17:15, 1 hr )
Talk at ZendCon Europe 2013 (English - US)

Rating: 4 of 5

Documenting code for dummies

Who are you?

Claim talk

Talk claims have been moved to the new Joind.in site.

Please login to the new site to claim your talk

 
Comments closed.

Comments

Rating: 3 of 5

19.Nov.2013 at 22:16 by Desislava (7 comments)

Nice examples of how to comment but they couldn't convince me why to comment so much.

I still think that really good code does not need so much commenting.
For example the date variable for which you added comments on few places it was certain string, you could put let's say at the begining of the class definition of a variable or constants named supportedDateFormats and define all supported formats so there will no need at all to explain everywhere that the format is yyyy-mm-dd, when you open the class you will see this which is more noticable and remembering.

Rating: 4 of 5

20.Nov.2013 at 21:35 by Dominic Watson (3 comments)

Clear, informative and interesting. I understand the examples were a little exaggerated like naming a DateTime parameter as $value and then documenting the type. I'm also feeling it a little pointless to document absolutely every variable when they're named $startDateTime and $endDateTime with typehinting also.

Rating: 4 of 5

21.Nov.2013 at 15:15 by Stefan Koopmanschap (400 comments)

Interesting and informative, very clear pronounciation and well-structured information.

Rating: 4 of 5

21.Nov.2013 at 22:46 by Daniel Gomes (54 comments)

The talk was very well conducted and informative.

Rating: 4 of 5

21.Nov.2013 at 22:46 by Daniel Gomes (54 comments)

The talk was very well conducted and informative.

Rating: 4 of 5

22.Nov.2013 at 11:40 by Gabriel Croitoru (13 comments)

Introductory talk to documenting. Good.

Rating: 5 of 5

22.Nov.2013 at 12:20 by Eugen Dimboiu (4 comments)

Very informative. Congrats!

Rating: 5 of 5

23.Nov.2013 at 19:10 by Wolfgang Weitlaner (14 comments)


© Joind.in 2019