הוסטס - פורום אחסון האתרים הגדול בישראל

הוסטס - פורום אחסון האתרים הגדול בישראל (https://hosts.co.il/forums/index.php)

- פורום תיכנות (https://hosts.co.il/forums/forumdisplay.php?f=14)

- - מבנה לתיעוד מחלקות (https://hosts.co.il/forums/showthread.php?t=26013)

בניה	09-07-06 21:39

מבנה לתיעוד מחלקות

ב"ה

למישהוא פה יש דוגמא לתיעוד שכתוב בצורה יפה?
אני מחפש מבנה יפה כדי להשתמש בו גם.

תודה ולילה טוב!

Itay	09-07-06 21:47

צורה יפה? פשוט תרשום מעל כל פונקציה מה היא מקבלת, מה היא מחזירה ובכללי מה היא עושה באנגלית

sUP	10-07-06 06:46

תעבוד לפי התיעוד הסטנדרטי..

PHP קוד:


		
			
/**

 * iTV.co.il - InterActive TV Site

 *

 * Sql Classes File - sql.php

 *

 * @author DaNiEl ToNY <dani@modem.co.il>

 * @package iTV Site Version 1.0

 */

או סתם נגיד תיעוד לפונקציה שעשיתי:

PHP קוד:


		
			
    /**

     * The Sql Select Queries function

     * 

     * How To Use Select function

     * @example $db->Select("Countey, City","tbl_name","WHERE `Username` = 'John'");

     * 

     * Structure: $db->Select($fields,$table,$more);

     * Query Var: $db->Select_Query

     */

אני לא הכי מומחה בזה אבל שאלתי כמה מתכנתים וותיקים והם אמרו שהתיעוד שלי אחלה

psycho

10-07-06 14:47

קוד:

/**

 * class שם ה

 *

 * בשורה אחת וקצת לאיזה שימוש הוא

 *

 * דוגמא לשימוש

 * דוגמא לשימוש   

 *   

 *

 * @author Firstname 'Nickname' Lastname <email@email.com>

 * @package class שם ה

 * @version 2.6(גירסא)

 */

נראה לי הכי חכם

BlueNosE

10-07-06 18:29

ראיתי מישהו עושה גם קצת מידע בVARים..
נניח

PHP קוד:


		
			
//@string bla ('hello');

var $bla = "hello";

כל הזמנים הם GMT +2. הזמן כעת הוא 19:29.