来晒晒你们喜欢的文件签名和注释风格吧！

[好好單调]

什么是文件签名啊？ 就是一般放在.h文件头部用来说明文件功能，修改日期，以及版权，作者信息等的内容（个人理解）。
什么是注释风格呢？ 主要是指在函数声明的地方进行的函数功能啊，参数啊，返回值之类的说明。


好了。API很多的文件签名类似如下样式：

/*++

Copyright (c) Microsoft Corporation.  All rights reserved.

Module Name:

    winbase_interlockedcplusplus.h

Abstract:

    C++ function overloads in place of "manual name mangling".
    This file is meant to be #included by winbase.h or any other file declaring the signed interlocked functions.

Author:

    Jay Krell (JayKrell) April 2002

--*/

函数注释风格：（API因为提供了SDK，所以介绍都很精简啊。)

//
// Very Large Memory API Subset
//

好了，接下来，大胆的Show一下你们的代码签名和注释风格吧。

[好好單调]

引用 1 楼 anhuizhuanjiao 的回复:

晒一个别人的吧，我的拿不出手 C/C++ code?12345678910111213/********************************************** 简介：CControlButton 控制按钮类，继承于CButton 实现控制按钮的绘制 功能：可加载按钮上四种状态图片，可任意改变其形状和响应区域 原作者： 修改： 修改内容：增加2……

哟西。。恭喜你抢到了沙发。。 你这个看起来有点太紧密了啊。。本来中文就比较紧凑。

[夏小安Lily]

[newtee]

喜欢VS自动生成的那个

[好好單调]

引用 15 楼 studyCBC 的回复:

引用 14 楼 a2619308 的回复:另外也说一说都是如何使用这些注释的。。 难道都是复制吗？ 注释不需要风格化，需要标准化，让人了解大致的消息

问题是现在没有一种标准，所以偏向于个人喜欢的风格吧

[七擒关羽]

引用 18 楼 a2619308 的回复:

引用 15 楼 studyCBC 的回复:引用 14 楼 a2619308 的回复:另外也说一说都是如何使用这些注释的。。 难道都是复制吗？ 注释不需要风格化，需要标准化，让人了解大致的消息 问题是现在没有一种标准，所以偏向于个人喜欢的风格吧

大多人喜欢这样的想法，所以代码的维护性越来越差，在同一个公司一些基本的规范和模式是需要的，这不是呆板，它可以为你带来很多效率

[七擒关羽]

引用 14 楼 a2619308 的回复:

另外也说一说都是如何使用这些注释的。。 难道都是复制吗？

注释不需要风格化，需要标准化，让人了解大致的消息

[dhdahai]

不怎么用签名的围观

[lwwit]

普通的，沒風格

[好好單调]

引用 19 楼 studyCBC 的回复:

引用 18 楼 a2619308 的回复:引用 15 楼 studyCBC 的回复:引用 14 楼 a2619308 的回复:另外也说一说都是如何使用这些注释的。。 难道都是复制吗？ 注释不需要风格化，需要标准化，让人了解大致的消息 问题是现在没有一种标准，所以偏向于个人喜欢的风格吧 大多人喜欢这样的想法，所以代码的维护性越来越差，在同一个公司一些……

我说的是不同的公司。 现在注释又没有统一的规范， 所以我才发这贴， 想了解下大家都有没有像公用的注释规范 或者说是好用的，简单美观实用的。。

[hongwenjun]

/** \brief This is a brief description.
 *
 * \param	p1 The first parameter.
 * \param	p2 The second parameter.
 * \return	Return value.
 *
 * This is a detailed description.
 */
wxString Function(wxInt32 p1, wxString p2)
{

wxInt32	iGlob;	/**< This is an inline comment. */

enum Enum{
	val1					/**< This is an inline comment. */
	val2					/**< This is an inline comment. */
}

wxString Function(wxInt32 p1, wxString p2)
{
	wxInt32	iVal;	/**< This is an inline comment. */

[anelmanager]

引用 5 楼 rangf 的回复:

文件签名： C/C++ code?1234567891011121314151617/********************************************************************** File Name : xxx.c Description : test item about XXX blo……

还是比较喜欢这个，现在用的也类似这样的 干净利索

[赵4老师]

比用什么风格更重要的是在任何地方，任何时候都坚持用一种风格。 比爱哪种美眉更重要的是在任何地方，任何时候都坚持爱一个美眉。

[好好單调]

引用 21 楼 hongwenjun 的回复:

C/C++ code?12345678910/** \brief This is a brief description. * * \param p1 The first parameter. * \param p2 The second parameter. * \return Return value. * * This is a detailed descri……

个人当时写过一个asp.net的网站时，发现自动生成的注释风格很不错。跟你这个很类似。 其实发现，如果能把所有注释都用英文写的话也会简单很多。同时也不用老在输入法之间切换了。

[好好單调]

引用 21 楼 hongwenjun 的回复:

C/C++ code?12345678910/** \brief This is a brief description. * * \param p1 The first parameter. * \param p2 The second parameter. * \return Return value. * * This is a detailed descri……

个人当时写过一个asp.net的网站时，发现自动生成的注释风格很不错。跟你这个很类似。 其实发现，如果能把所有注释都用英文写的话也会简单很多。同时也不用老在输入法之间切换了。

[好好單调]

引用 23 楼 zhao4zhong1 的回复:

比用什么风格更重要的是在任何地方，任何时候都坚持用一种风格。 比爱哪种美眉更重要的是在任何地方，任何时候都坚持爱一个美眉。

呵呵。。 对啊。。 不知道有没有大神用脚本语言自动生成注释了

[hongwenjun]

引用 26 楼 a2619308 的回复:

引用 23 楼 zhao4zhong1 的回复:比用什么风格更重要的是在任何地方，任何时候都坚持用一种风格。 比爱哪种美眉更重要的是在任何地方，任何时候都坚持爱一个美眉。 呵呵。。 对啊。。 不知道有没有大神用脚本语言自动生成注释了

上面发的 风格是 doxygen 插件 引用注释，可以提取到自动文档里

[搬砖随想录]

引用 23 楼 zhao4zhong1 的回复:

比用什么风格更重要的是在任何地方，任何时候都坚持用一种风格。 比爱哪种美眉更重要的是在任何地方，任何时候都坚持爱一个美眉。

[好好單调]

引用 27 楼 hongwenjun 的回复:

引用 26 楼 a2619308 的回复:引用 23 楼 zhao4zhong1 的回复:比用什么风格更重要的是在任何地方，任何时候都坚持用一种风格。 比爱哪种美眉更重要的是在任何地方，任何时候都坚持爱一个美眉。 呵呵。。 对啊。。 不知道有没有大神用脚本语言自动生成注释了 上面发的 风格是 doxygen 插件 引用注释，可以提取到自动文档里 ……

额。 求教程啊。。

[七擒关羽]

。。。这个现在大部分的文档编辑都有脚本插件的，只要你按照模板写插件就可以

[好好單调]

引用 29 楼 studyCBC 的回复:

。。。这个现在大部分的文档编辑都有脚本插件的，只要你按照模板写插件就可以

倒是听说过这么东西。 但是VS我还没见到谁用过。。用过的给指点下啊。