نوشتن توضیحات (کامنت) در خصوص تابع

[phoenix2000]

در مثال هایی که از خود ST وجود داره قبل از تعریف تابع توضیحاتی در خصوص تابع نوشته شده مثلا:

/**
  * @brief  Reports the name of the source file and the source line number
  *         where the assert_param error has occurred.
  * @param  file: pointer to the source file name
  * @param  line: assert_param error line source number
  * @retval None
  */
void assert_failed(uint8_t* file, uint32_t line)
{
  /* User can add his own implementation to report the file name and line number,
     ex: printf("Wrong parameters value: file %s on line %d\r\n", file, line) */

  /* Infinite loop */
  while (1)
  {}

}

به نظر میاد که فرم کلی و قالب این توضیحات به صورت اتوماتیک ایجاد شدن و راه کاری برای این کار وجود دارد. اگه حدسم درست باشه پس از ایجاد این قالب تنها کافیه که مثلا جلو قسمت پارامترها در خصوص پارامترها توضیحاتی بدهیم و به همین ترتیب برای بقیه قسمت ها. چیزی مشابه گذاشتن /// قبل از یک متد در ویژوال استادیو.
از دوستان کسی تا حالا تونسته این کار رو بکنه و یا راه حلی برای این کار وجود داره یا نه اصلا فرض من از اول اشتباه بوده و این توضیحات با کپی پیست ایجاد شدن.
راستی فراموش کردم بگم که با استفاده از IDE کیل منظورم هست. هر چند اگر با سایر IDE ها هم تجربه ای در این خصوص دارید مطرح کردنش مفید خواهد بود.

[روح الامین]

پاسخ : نوشتن توضیحات (کامنت) در خصوص تابع

اگه درست یادم بیاد اینا بخاطر ساختن فایل راهنما هستش. احتمالا با برنامه هم تولید میشه. حالا این برنامه رو خود شرکت نوشته یا کس دیگه رو نمی دونم ولی خب قشنگه و تاثیر خیلی خوبی هم رو یادگرفتن داره. من تا حالا باهاشون کار نکردم ولی چندتا دوست داشتم که با شرکت های مشهور کار میکردن و با برنامه هایی مثل Doxygen فایل راهنمای کدها و کتابخونه هاشون رو ایجاد میکردن.
به فایل راهنمای کتابخانه های مشهور مثل CMSIS نگاه کن:

http://www.keil.com/pack/doc/CMSIS/General/html/index.html

حالا به فایل های نمونه تولید شده بعضی شرکت ها نگاه کن:

http://www.stack.nl/~dimitri/doxygen/results.html

http://www.stack.nl/~dimitri/doxygen/projects.html