Manual code commenting

Discussion forum for MOD Writers regarding MOD Development.
Locked
RedactUK
Registered User
Posts: 60
Joined: Mon Apr 12, 2004 10:02 am
Location: Cambridge, UK
Contact:

Manual code commenting

Post by RedactUK » Sun Jan 08, 2012 2:59 pm

Hey guys

I want to adopt a commenting standard for some manual edits and minor modifications to phpbb3. Changes i make won't be public, but I would like to try and use same standard made when MODX edits core files. I'm familiar with the old text file MOD standards for commenting edits, and I can see some changes made by some MODX installs i've made, but is there a topic/FAQ that lists the commenting style used by MODX?

Thanks

User avatar
HGN
Former Team Member
Posts: 4706
Joined: Wed Dec 03, 2008 1:53 pm
Location: The Netherlands
Name: Alfred
Contact:

Re: Manual code commenting

Post by HGN » Sun Jan 08, 2012 4:36 pm


RedactUK
Registered User
Posts: 60
Joined: Mon Apr 12, 2004 10:02 am
Location: Cambridge, UK
Contact:

Re: Manual code commenting

Post by RedactUK » Sun Jan 08, 2012 5:04 pm

Thanks for the reply, but i'm still not getting it. In phpbb2 when I manually modded files I would add comments similar to the following:

Code: Select all

//-- mod : My MOd -------------------------------------

//-- mod : My Mod -------------------------------------------------------------
//-- add	
		$this->user_mod_stats = array();
//-- end mod : MyMod ---------------------------------------------------------
So is this notation still inserted by MODX modifications into code thats changed?

RedactUK
Registered User
Posts: 60
Joined: Mon Apr 12, 2004 10:02 am
Location: Cambridge, UK
Contact:

Re: Manual code commenting

Post by RedactUK » Sat Jan 14, 2012 3:40 pm

Anyone?

User avatar
doktornotor
Registered User
Posts: 608
Joined: Fri Sep 09, 2011 7:41 am

Re: Manual code commenting

Post by doktornotor » Sat Jan 14, 2012 3:49 pm

RedactUK wrote:Anyone?
What do you need? There is no standard for comments (beyond valid syntax), or even a need for them.
Support requests via PM go straight to /dev/null!

RedactUK
Registered User
Posts: 60
Joined: Mon Apr 12, 2004 10:02 am
Location: Cambridge, UK
Contact:

Re: Manual code commenting

Post by RedactUK » Wed Jan 18, 2012 1:25 am

doktornotor wrote:rr even a need for them.
No need for comments in code that has been modified?! :shock:

I've been looking through several official mods today and just find it strange that none of them seem to include any comments in the code itself, and that doing so is not part of the MODX standards, at least not that I can find anywhere. In my opinion this makes developing so much harder, as looking through modified code you have no idea what is standard and what has been modfied by an existing mod. Sure I can and will add my own, but adding them to every 3rd party mod i install just because the MOD standards don't even suggest it's good practise for others to include them, is a little tedious :(

Locked

Return to “[3.0.x] MOD Writers Discussion”