Friday 18 November, vers 23h, Tobias Toedter tapota :

> Author: toddy
> Date: Fri Nov 18 23:48:02 2005
> New Revision: 5010
> 
> URL: http://svn.gna.org/viewcvs/savane?rev=5010&view=rev Log: Added
> new function utils_unixtime_to_date() to be able to support
> different calendars. It should replace the former used function
> format_date().  Furthermore, the source for both functions has been
> extensively documented. The syntax can be used by phpDocumentor to
> generate various formats of API references.
> 

I'm not very happy with the way it is documented, actually. I think
way more useful to have simple comments inside functions that a big
bunch that you dont wanna read just before.

Also, I'm not sure when writing code we want to at the same time using
a complicated syntax for comments. I cannot picture me writing
something like 
          @param string A format string in <samp>strftime()</samp> syntax
I cannot even understand what it actually means, or barelly.

Plus, using C style commenting would means one more time have
inconsistant coding style for comments.

Couldnt we go for a more simple approach? 

-- 
Mathieu Roy

  +---------------------------------------------------------------------+
  | General Homepage:           http://yeupou.coleumes.org/             |
  | Computing Homepage:         http://alberich.coleumes.org/           |
  | Not a native english speaker:                                       |
  |     http://stock.coleumes.org/doc.php?i=/misc-files/flawed-english  |
  +---------------------------------------------------------------------+

_______________________________________________
Savane-dev mailing list
[email protected]
https://mail.gna.org/listinfo/savane-dev

Reply via email to