Açıklama satırlarının önemi ve kuralları

baran123 · 25 Ekim 2016, 19:54:34

Kodlara/Kütüphanelere yazılan açıklamalar hakkında konuşalım.
Bunu profesyonelce yapmak için nelere dikkat etmek gerekir ?
Bu işin belirli bir standardı var mı ?
Ben genelde kütüphanenin başlık kısmına şu şekilde bir alan eklerim.

/**
 *    Kütüphane ismi
 * 
 *    @file   
 *    @author  
 *    @email   
 *    @website 
 *    @ide     
 *    @compiler 
 *    [member=43047]hardware[/member] 
 *    @version  
 */

Fonksiyon başlarına ise şu şekilde yaparım.

/*****************************************************
* Function Name : 
* Description   : 
* Input         : 
* Return        : 
******************************************************/

Bunlar ne kadar doğru ? Bu ayrıntıları öğrenebileceğimiz bir kitap-kaynak var mı ?

muhittin_kaplan · 26 Ekim 2016, 15:46:34

@baran123 doxygen bir araştır.

Picproje Elektronik Sitesi

Haberler:

Açıklama satırlarının önemi ve kuralları

baran123

muhittin_kaplan