读书人

关于代码中的格式有关问题

发布时间: 2013-03-16 11:51:46 作者: rapoo

关于代码中的格式问题
请初看以下代码:

class CCamera
{
public:
XMMATRIX View;

/// <summary>
/// Constructor
/// </summary>
CCamera();

/// <summary>
/// Handles window messages, used to process input
/// </summary>
/// <param name="hWnd">window message is for</param>
/// <param name="uMsg">message</param>
/// <param name="wParam">message data</param>
/// <param name="lParam">additional message data</param>
/// <returns>result of message processing</returns>
LRESULT HandleMessages(HWND hWnd, UINT uMsg, WPARAM wParam, LPARAM lParam);

/// <summary>
/// Reset the camera state to initial values
/// </summary>
void Reset();

/// <summary>
/// Update the view matrix
/// </summary>
void Update();

/// <summary>
/// Get the camera's up vector
/// </summary>
/// <returns>camera's up vector</returns>
XMVECTOR GetUp() { return m_up; }

/// <summary>
/// Get the camera's right vector
/// </summary>
/// <returns>camera's right vector</returns>
XMVECTOR GetRight() { return m_right; }

/// <summary>
/// Get the camera's position vector
/// </summary>
/// <returns>camera's position vector</returns>
XMVECTOR GetEye() { return m_eye; }

private:
float m_rotationSpeed;
float m_movementSpeed;

float m_yaw;
float m_pitch;

XMVECTOR m_eye;
XMVECTOR m_at;
XMVECTOR m_up;
XMVECTOR m_forward;
XMVECTOR m_right;

XMVECTOR m_atBasis;
XMVECTOR m_upBasis;
};


在上述的代码中,有些注释:
/// <summary>

   /// <param name="hWnd">window message is for</param>
/// <param name="uMsg">message</param>


/// <param name="wParam">message data</param>
/// <param name="lParam">additional message data</param>
/// <returns>result of message processing</returns>


/// <returns>camera's position vector</returns>


这都是手敲进去的吗?还是有特定的归档工具来实现它呢?
谢谢! 程序格式 C++
[解决办法]
试试VC助手,不过那么多注释也没有多用,除非为了自动生成文档。注释按需添加就可以。
[解决办法]
这是某种类似于Doxygen的注释风格,用于通过解析源文件自动生成文档。
[解决办法]
这个肯定不是手动敲的,用VS的话Visual Assist的C#方法默认注释格式就是这样的,C++的如果想改成这样也可以改的
[解决办法]
工具生成的,手敲还不累死啊。
[解决办法]
VC助手 Visual Assist X 中可以为文件头描述,函数头注释等等自定义模板,这样的话可以方便的插入文件注释或函数注释。本来截了几张图,发不上来,CSDN发图功能很差啊
[解决办法]
引用:
引用:工具生成的,手敲还不累死啊。

我也觉得不会是手敲的,就算复制粘贴也麻烦,所谓工具会是LS所说的VC助手或者Doxygen?
去试试看。

Doxygen是提取注释生成文档.
C++的话 VC助手可以生成,也有其他插件可以生成。

读书人网 >C++

热点推荐