Internet & Web Application

การใช้งาน Doxygen & Coding Style

Coding เรื่องใหม่ไม่ยากเท่ากับ การกลับมาอธิบาย Code เก่าๆ .. หากทำไป Comment ไป และยังอาศัย Doxygen หยิบเอา Comment ใน Source code กลับมาจัดทำ Technical report แบบอัตโนมัตด้วยนี่สิ ยิ่งดีใหญ่สามารถศึกษาได้จาก >

http://thep.blogspot.com/2005/10/cc-doc-generator.html

http://www.compgeom.com/~piyush/teach/3330/slides/doxy_tutorial.pdf

class.ee.iastate.edu/cpre288/lectures_files/DoxygenTutorial.pdf

ตัวอย่างหนึ่งจาก wiki >

/**
 * @file
 * @author  John Doe <jdoe@example.com>
 * @version 1.0
 *
 * @section LICENSE
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License as
 * published by the Free Software Foundation; either version 2 of
 * the License, or (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * General Public License for more details at
 * http://www.gnu.org/copyleft/gpl.html
 *
 * @section DESCRIPTION
 *
 * The time class represents a moment of time.
 */
 
class Time {
 
    public:
 
       /**
        * Constructor that sets the time to a given value.
        * 
        * @param timemillis Number of milliseconds 
        *        passed since Jan 1, 1970.
        */
       Time (int timemillis) {
           // the code
       }
 
       /**
        * Get the current time.
        *
        * @return A time object set to the current time.
        */
       static Time now () {
           // the code
       }
};

 

Advertisements
มาตรฐาน

ใส่ความเห็น

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / เปลี่ยนแปลง )

Twitter picture

You are commenting using your Twitter account. Log Out / เปลี่ยนแปลง )

Facebook photo

You are commenting using your Facebook account. Log Out / เปลี่ยนแปลง )

Google+ photo

You are commenting using your Google+ account. Log Out / เปลี่ยนแปลง )

Connecting to %s