code-comments

    0热度

    2回答

    我倾向于在1种方法中写出相当多的评论。偶尔,我指的是另一个类中的另一种方法或属性。它类似于: //如果取消注释下一行,请确保检查'MyClass.SomeMethod'。 [更新] 在试图希望得到较少的代码臭评论。也许它可能会像(谢谢@韦斯顿): /// <summary> /// Adds two numbers /// See method Subtract for the opposit

    1热度

    2回答

    我希望有一个命令来切换注释在Python代码行/块中。 我使用下面的代码在我.vimrc文件: " (un-)commenting " comment line, selection with Ctrl-N,Ctrl-N au BufEnter *.py nnoremap ,c mn:s/^\(\s*\)#*\(.*\)/\1#\2/ge<CR>:noh<CR>`n au BufEnter

    0热度

    1回答

    在我的代码中,我有多个分散的行,它们帮助我调试程序并显示执行过程中发生了什么。有没有一种简单而快速的方法来评论和取消注释(切换)vim中的这些固定行?我想到了在蟒蛇有特殊标记标志这些线(例如//)是这样的: print "Debug!" # // ,每次一个sepcific快捷键被按下所有这一切最终以“#‘一些可选的描述性文字’行// “分别评论或取消注释。 我已经看过NERD Comment

    2热度

    2回答

    Qt Creator通常将评论的颜色设置为绿色,但我在Qt示例中看到了蓝色的评论,而Qt Creator似乎对每个注释都以//!开头的蓝色着色。 下面是一个例子截图: 这是一些约定?蓝色意味着什么?

    2热度

    1回答

    我使用phpCheckstyle phpcheckstyle来标准化我的代码注释。在验证文件的警告后,它建议 “文档块注释应该包括关于每个PHP文件的文件(@file)的信息” 添加@file标签时会解决警告 - 我想知道应该为此标签分配什么值它表示的是什么)。 ,是什么@file和@filesource 感谢之差,

    9热度

    1回答

    对于文档,我们通常必须创建一个额外的文档,描述在代码(e.g. /* lint --e228)中禁用任何lint消息时我们所做的操作。 这将使它更容易与doxygen一起使用(因为我们无论如何创建这个)。 虽然,我无法找到任何解决方案如何使doxygen使用这些皮棉评论。 有没有人试过? 有没有解决方案如何使用stric '/*lint'但无论如何将它添加到doxygen? 谢谢!

    8热度

    3回答

    在我的一个项目上运行声纳后,我收到了'尾随评论'的违规问题。所以我想知道,这是纯粹与Java的接受/推荐的代码布局约定相关吗?还是“还有更多”?它背后的理由是什么?当我查看一些C++代码时(最近的Doom code review,后面的注释有很多(或全部)尾部注释

    0热度

    1回答

    我有关于编写标准javadoc评论的问题。 他们要求我们尽可能具体,并使用谓词来描述代码,但是如果我的评论中写有一个变量“d”,但未在我的代码中指明,是否会造成问题? 再一次,我问这个问题,因为我感到困惑,我的老师严格评论代码。 /** * Find the great common divisor between a 2 number. * * @param a number1 * @p

    0热度

    1回答

    我知道有静态分析工具,例如FindBugs(其中有bunch)可静态执行代码分析,也可以作为连续构建过程的一部分进行调度。这些工具在代码部分上运行。评论同样重要,如果可以检测到任何差异并向有关开发者报告(作为构建过程的一部分),那将是非常好的。 我一直在寻找的能力,其中一个工具也可以标记缺少适当评论的实例。我指的是标准的Javadoc风格的注释像类,方法等

    0热度

    2回答

    我做了重定向例如链接.htaccess文件: website.com/module#controller 到: website.com/?url=module #controller 由于#是PHP评论庄家,我得到的问题,当需要加载: $ bootstrap->的init($网址)// $ URL =模组#控制器; 我试过用addslashees($ url);,但仍然当我: echo $ url