सुंदर कोड टिप्पणी ब्लॉक डिज़ाइन: दीर्घाओं, लेख, वरीयताओं

मैं हमेशा अपने कोड को बहुत अधिक दस्तावेज करता हूं ताकि अन्य (और खुद सड़क से नीचे) जल्दी से समझ सकें कि क्या हो रहा है। तो मुझे अक्सर आश्चर्य होता है कि वहां कोई गैलरी या टिप्पणी डिजाइन का संग्रह है या नहीं। कोई लिंक या सिर्फ सामान्य वरीयताएँ?सुंदर कोड टिप्पणी ब्लॉक डिज़ाइन: दीर्घाओं, लेख, वरीयताओं

यहां एक जोड़े हैं जो मैं अक्सर (PHP में) उपयोग करता हूं।

एक फ़ाइल के शीर्ष पर:

// ******************************* INFORMATION ***************************// 

// ***********************************************************************// 
// 
// ** NAME - A description of what the file does. 
// ** 
// ** @author name <[email protected]> 
// ** @date date 
// ** @access private 
// ** @param  
// ** @return if a class what object is returned 
//  
// ***********************************************************************// 

// ********************************** START ******************************//

कार्यों के एक समूह लेबल करने के लिए प्रयोग किया जाता है:

// =======================================================================// 
// ! A description of what the following functions have in common   //   
// =======================================================================//

मैं हमेशा सबसे कठिन समय के बाद से "टिप्पणी ब्लॉक" इस विषय पर खोज कर लिया है या "कोड टिप्पणियां" आमतौर पर ब्लॉग के लिए एक टिप्पणी प्रणाली लिखने पर सामान लौटाती हैं :)

स्रोत

2011-06-18 websiteguru

यह बहुत ही व्यक्तिपरक होगा, आईएमओ –

यह आपके लिए बहुत दिलचस्प हो सकता है: http://manual.phpdoc.org/HTMLframesConverter/default/ –

जाहिर है। हालांकि, सवाल यह नहीं है: ".. वहाँ कई दीर्घाओं या टिप्पणी डिजाइन का संग्रह वहाँ बाहर?" – websiteguru

हालांकि यह @jcomeau_ictx द्वारा सुझाए गए व्यक्तिपरक है, phpDocumentor (या phpdoc या phpd जैसी कोई चीज़ है) OCU)। मैं अत्यधिक अनुशंसा करता हूं कि आप इसे देखें। आप दस्तावेज http://manual.phpdoc.org/HTMLframesConverter/default/ पर पा सकते हैं।

उनका वाक्यविन्यास आपके से थोड़ा अलग है। यह जावाडोक के समान है।

उदाहरण के लिए:

/** 
* Sample File 3, phpDocumentor Quickstart 
* 
* This file demonstrates the use of the @name tag 
* @author Greg Beaver <[email protected]> 
* @version 1.0 
* @package sample 
*/

आप साइट पर देखने के लिए के लिए कुछ उदाहरण हैं।

आप को देखने के लिए अन्य डेवलपर्स क्या कर रहे हैं चाहते हैं, आप भी http://www.google.com/codesearch की जाँच और PHP फ़ाइलों के लिए खोज कुछ शब्दों है कि और अधिक टिप्पणियां (function या class जैसे) होने की संभावना है जिसमें सकता है।

स्रोत

2011-06-18 18:51:47

मुझे इसके बारे में पता है ... मैंने हमेशा इसे बहुत बदसूरत पाया है :-p – websiteguru

@websiteguru - फिर, यह व्यक्तिपरक है। मैंने व्यक्तिगत रूप से वर्षों और जवाडोक का उपयोग वर्षों से किया है। मैं कहने के लिए लगभग तैयार हूं कि यह एक "मानक" है। यदि आप "गैलरी" चाहते हैं, तो [http://www.google.com/codesearch ](http://www.google.com/codesearch) को देखने का प्रयास करें और देखें कि अन्य लोग क्या कर रहे हैं। –

सुंदर कोड टिप्पणी ब्लॉक डिज़ाइन: दीर्घाओं, लेख, वरीयताओं

उत्तर

संबंधित मुद्दे