各种编程语言的「注释」分别怎么写？
2012-01-19 20:21:49   来源：   点击：

2 个答案

• 答案 1：

  各种语言可能有不同的注释标示符, 比如: /* */ # // /// 等等但各种语言可以有统一的注释风格我个人是遵循doxygen的注释风格, vim里用了doxygen注释插件http://www.doxygen.org/一方面是为了方便生成注释文档(好注释写出来直接就是好文档)另一方面也是想统一各种注释风格, 让大家互相看得懂是什么意思openocd.berlios.de/doc/doxyge...举几个常用的C注释:

  函数注释: 注释里面最重要的部分, 这个不能省

  /** @brief //函数功能注释* @param [in/out] 变量名 : 变量类型 //参数注释* @return 返回值类型 // 返回值注释* @retval // 返回值取值注释* @see //参考关联函数* @author //作者* @date //生成时间*/

  变量注释: 变量声明时的注释

  int foo; ///小于号 变量注释 (小于号会被吃掉, 用符号替换文字即可)

  功能注释: 特定的功能介绍

  foo = 1; // 功能注释或者// 功能注释foo = 1;foo = 2;

  文件注释:

  /**************************************************************************** Copyright/Copyleft 2011 XXX. (All Rights Reserved)**************************************************************************//*** @file foobar.cpp* @author 名字(Mail)* @date * @brief**/

• 答案 2：

  Comparison of programming languages (syntax) - Comments en.wikipedia.org/wiki... 基本都在这里了。