Please login or register.

Login with username, password and session length
Advanced search  

News:

Latest sNews - sNews 1.7 - with its own forums - for discussion and user mods.

Author Topic: Lack of Comments  (Read 8513 times)

Rob

  • Full Member
  • ***
  • Karma: 1
  • Posts: 219
    • http://www.ruthinweather.co.uk
Lack of Comments
« on: September 12, 2006, 03:40:35 PM »

Just reviewed your lovely piece of code and I am amazed by the lack of comments in the code.  Have the comments been removed for a purpose or is there just none?
Logged
The road the righteous travel is like the sunrise, getting brighter and brighter until daylight has come.

mattd

  • Full Member
  • ***
  • Karma: 0
  • Posts: 121
Lack of Comments
« Reply #1 on: September 12, 2006, 06:55:19 PM »

Dont think there were any comments in 1.4 either!

There are quite a few coding style things I personally dont like but I am assuming that they did it like they have for PHP parsing optimisation, and not just bad code style, right? :)
Logged

Mika

  • Hero Member
  • *****
  • Karma: 9
  • Posts: 1377
    • http://www.ni5ni6.com/
Lack of Comments
« Reply #2 on: September 12, 2006, 07:02:35 PM »

right ;)
Logged
http://www.ni5ni6.com/ - Tutorials, Mods and How-To's about sNews CMS
sNews 1.6 Developers Edition - commented sNews 1.6 version

Mika

  • Hero Member
  • *****
  • Karma: 9
  • Posts: 1377
    • http://www.ni5ni6.com/
Lack of Comments
« Reply #3 on: September 17, 2006, 12:13:19 PM »

I owe you an explanation for the absence of comments: I like commented code as well, and there's been heavy commenting done on my part - otherwise Luka couldn't catch up with me -  but all the commments has been removed; if we had left them, the engine would be at least 1/3 larger than it is now. mattd already mentioned other important thing...

this is just between us, ok? I couldn't risk to break the 100Kbytes barrier because Luka threatened me that he'll (hell?) deny me all the beer when we finally meet if my code gets huge. and believe me, i've work hard to earn that beer

:D
Logged
http://www.ni5ni6.com/ - Tutorials, Mods and How-To's about sNews CMS
sNews 1.6 Developers Edition - commented sNews 1.6 version

Fred K

  • Still trying to learn stuff
  • ULTIMATE member
  • ******
  • Karma: 130
  • Posts: 2728
    • Personal
Lack of Comments
« Reply #4 on: September 17, 2006, 05:58:51 PM »

to be denied beer after such an amount of work would surely be hell. Not to mention rum and punch... :lol:
Of course, it would be cool to read all your comments, mika. But not at the expense of a bloated app. Bloatware I've had enough of.

Quote from: mika The Administrator
otherwise Luka couldn't catch up with me
hehehe
Logged

Keyrocks

  • Doug
  • ULTIMATE member
  • ******
  • Karma: 449
  • Posts: 6019
  • Semantically Challenged
    • snews.ca
Lack of Comments
« Reply #5 on: September 17, 2006, 08:24:10 PM »

Mika - would you have... perhaps... kept a copy of the heavily commented file as it was before you made a copy of it and cleaned up the copy for the distribution RC package? If so, perhaps you might be willing to make it available to those few who really want it for reference purposes. That would be useful to those who wish to do some serious modding. :)
Logged
Do it now... later may not come.
-------------------------------------------------------------------------------------------------
sNews 1.6 MESU | sNews 1.6 MEMU

Luka

  • Administrator
  • ULTIMATE member
  • ******
  • Karma: 36
  • Posts: 1716
    • http://www.snewscms.com
Lack of Comments
« Reply #6 on: September 17, 2006, 08:58:48 PM »

Quote from: mika
this is just between us, ok? I couldn't risk to break the 100Kbytes barrier because Luka threatened me that he'll (hell?) deny me all the beer when we finally meet if my code gets huge. and believe me, i've work hard to earn that beer

:D
Yeah, blame it on me. You've just lost that beer pal :)
Logged

Mika

  • Hero Member
  • *****
  • Karma: 9
  • Posts: 1377
    • http://www.ni5ni6.com/
Lack of Comments
« Reply #7 on: September 17, 2006, 10:05:59 PM »

darn!
Logged
http://www.ni5ni6.com/ - Tutorials, Mods and How-To's about sNews CMS
sNews 1.6 Developers Edition - commented sNews 1.6 version

Mika

  • Hero Member
  • *****
  • Karma: 9
  • Posts: 1377
    • http://www.ni5ni6.com/
Lack of Comments
« Reply #8 on: December 08, 2006, 03:09:11 PM »

I've spent some free time (which I don't really have but hey... who does? :D) to finish what I've promised - commented version of snews.php file (latest stable version 1.5.30).

More info and download can be found here: http://www.ni5ni6.com/home/snews-cms-developers-edition-available/
Logged
http://www.ni5ni6.com/ - Tutorials, Mods and How-To's about sNews CMS
sNews 1.6 Developers Edition - commented sNews 1.6 version

Keyrocks

  • Doug
  • ULTIMATE member
  • ******
  • Karma: 449
  • Posts: 6019
  • Semantically Challenged
    • snews.ca
Lack of Comments
« Reply #9 on: December 08, 2006, 06:24:37 PM »

Thanks Mika. Downloaded it and will take a look - hope it helps me understand some stuff better.

(added:) I just finished reading through your Developer's "commented" snews.php and I must say... you did an excellent job of explaining what the functions do... especially function extra and function filelist. Thanks for sharing this with us! :)
Logged
Do it now... later may not come.
-------------------------------------------------------------------------------------------------
sNews 1.6 MESU | sNews 1.6 MEMU

piXelatedEmpire

  • MIA
  • ULTIMATE member
  • ******
  • Karma: 37
  • Posts: 1401
  • currently MIA
Lack of Comments
« Reply #10 on: December 09, 2006, 05:39:20 AM »

this is a FANTASTIC reference Mika.. I could kiss you!

 :P
Logged
my apologies to the sNews crew, but I will be MIA for the forseeable future

Mika

  • Hero Member
  • *****
  • Karma: 9
  • Posts: 1377
    • http://www.ni5ni6.com/
Lack of Comments
« Reply #11 on: December 09, 2006, 06:12:11 AM »

:) I'm glad you like it
Logged
http://www.ni5ni6.com/ - Tutorials, Mods and How-To's about sNews CMS
sNews 1.6 Developers Edition - commented sNews 1.6 version