Documentation, even if this is MediaWiki

Jump to: navigation, search

I propose merging in these guidelines to improve the quality of code documentation and increase code readability.

-- Jeroen De Dauw 11:58, 21 July 2010 (UTC)07:11, 5 December 2011

Sounds like a good idea.

Tisane 16:18, 21 July 2010 (UTC)07:12, 5 December 2011

Sounds nice, except for the part about using @since...do we really want that?

--Jack Phoenix (Contact) 18:06, 21 July 2010 (UTC)07:12, 5 December 2011

I don't see any reason not to have it, and a lot of reason to do have it. I figure it's not really possible to add it to all current code accuratly, but I'd be very nice if people just added it when writing new code.

--Jeroen De Dauw 21:08, 25 July 2010 (UTC)07:12, 5 December 2011

I like almost all of your proposals, just a bit skeptical with the @since. I have noticed, you have been using this in your extensions but even if you tag something as @since 0.1 and in 0.2 the whole function changes and gets new arguments, I am not sure you would update it to @since 0.2 or add a note. One way would be using multiple @since in this case and adding a note behind that how it was different back then. Anyway, I have missed this many times in MW core, would be so much easier to keep backwards compatibility if this were documented properly! Especially for public functions but also for important constants and globals.

Danwe01:22, 6 December 2011
 
 
 

No further objections to me merging this stuff in?

-- Jeroen De Dauw 05:17, 9 August 2010 (UTC)07:12, 5 December 2011
 

Go go gadget wikimerger!

Krinkle23:37, 5 December 2011

This thread is over a year old...how did so many old threads get bumped?

^demon00:43, 6 December 2011

Because of the conversion to LQT :-)

Helder01:38, 6 December 2011