好用的註解程式

之前在學stm32的時候，發現他的註解都很特別

今天花時間看了一下到底為什麼要用這麼奇怪的註解

原來他是使用Doxygen 的註解程式

一開始的時候，我還不是很懂有什麼功能

當我去網路上找到這個程式的介紹後，似乎慢慢的了解了

改了一下範例

/**
  ******************************************************************************
  * @file  mac.c
  * @author  DoubleTime
  * @version  V3.0.0
  * @date  2010/06/16
  * @brief  This file Doxygen test
  ******************************************************************************
  * @copy
  *
  *
  *
  *
  *
  *
  *
  *
  *

© COPYRIGHT DoubleTime

  */

    /**
     * teset
     *
     * @param a   a is parameter 1
     * @param b   b is parameter 2
     *
     * @return a+b
     */

int teset(int a, int b){

 return a+b;
}
int kkk;
int main(void){
 kkk=teset(4,5);
 while(1);
}

 

執行完Doxygen後，變成網頁式的程式瀏覽，好漂亮，只要副程上有註解的地方，就可以用滑鼠直接點過去觀看註解，超棒的！

Doxygen 也會把屬於它的註解程式刪除，在觀看程式的時候，乾淨利落

ps：不過短時間，我應該不會花太多時間做這樣程式的註解吧！