标签: comments

每个人都知道更易读的代码的优点.因此,为了使我的代码更具可读性,我通常在该类的实现文件中包含注释类声明.
这样我就不必浏览各种include目录来定义.
那么,这是一个很好的做法还是只是过度记录？
如果有一些标准技术,请告诉我.
编辑:
有没有办法从Vim中的实现迁移到类声明？
除了在新缓冲区中打开它.

谢谢

这可能听起来像一个愚蠢的问题或观察,但我已经看到,大多数时候,当一个人试图查看开源代码,没有评论或只是一两行在函数的开头告诉功能是什么用于例如注册用户或表中的数据等.没有代码实际上解释了功能正在做什么等.

当代码发布到开源社区以使其他人难以理解时,是否故意(删除评论)？

你能告诉我/*=NULL*/下面的意思吗？

CMyCla::CMyCla(CWnd* pParent /*=NULL*/)
    : CDialog(CCycleTimes::IDD, pParent)
{
    // Some code here
}

顺便说一句,我复制了同一条线.

成功评论为下面的syte

// CMyCla::CMyCla(CWnd* pParent /*=NULL*/)
//  : CDialog(CCycleTimes::IDD, pParent)

否则,评论失败为下面的样式.

/*
    CMyCla::CMyCla(CWnd* pParent /*=NULL*/)
        : CDialog(CCycleTimes::IDD, pParent)
*/

为什么评论操作失败了？

嗨,我有50页的代码,我应该给它写评论......你们能告诉我最好的方法吗？我的意思是我需要你给我写一个样本......注释应该包含几乎所有东西(类,构造函数,属性,方法,事件,函数)

我的网站有几个列表页面,在每个页面上,我想启用一个评论机制,但我希望它尽可能像开源一样.这意味着完全使用OpenID,Facebook连接等.是否存在允许用户在我的列表页面上发表评论的系统？

顺便说一句,我的网站使用LAMP架构.

显然,我是一名新手网页设计师.我正在使用php和sql做所有引擎盖下的东西,但我想要一个视觉上吸引人的功能评论系统.

现在我只是使用HTML表单,但它们看起来不太好.我应该使用javascript吗？让我入门的任何提示？

我有三行代码:

 //int pi;
 activation->structSize = sizeof(rmsActivationT);
 int pi; //program wont compile with this here

每次我取消注释第二个int pi并注释第一个int pi我得到这个错误:语法错误:缺少';' 在'类型'之前.当我取消注释第一个int pi并注释第二个int pi时,我的编译器不再抱怨了.这个错误一直困扰着我几乎一整天,现在任何想法都会很棒.

谢谢

Visual Studio 2008 Windows XP 32位

我现在正在用C++记录一些代码,我打算编写的一个方法将对数组进行排序.但是,它不会创建新数组,它会对给定数组的元素进行排序.我希望包括一句话,"如果原始排序对你很重要,那么就不要使用这种方法!" 但我宁愿说出一些类似"对给定数组进行排序......静态地？!......危险!......有突变!!!" 像你这样的程序员能够理解.

用什么词来形容这种方法？

额外的问题:任何人都可以推荐一个C++工具,它可以从特殊格式的注释中创建HTML文档,比如javadoc？我选择的操作系统是Ubuntu.

编辑:我是学生,我的任务是排序.

用多少种语言/* ........... */作为评论？除了CSS

如果有人知道这些类型的评论的名称,如果存在,请修改我的问题.

我经常看到这样的评论块:

/**********************************************
 *          Some Important Text Here
 **********************************************/

有时它们看起来像这样:

/**********************************************
  *********  Some Important Text Here  ******* 
 **********************************************/

我也看到它们比那更漂亮.

它们似乎对于记录代码段和重要消息(如许可证块)很有用.但是,我觉得*必须*在Visual Studio中做一个"懒惰"的方式,或者至少是一个插件,因为手动输入它们很痛苦.

谢谢!

PS如果这个功能或点击方式不存在,那么我知道我接下来要写的VS插件.