Tag: 评论

SQL注释头的例子

只是想看看什么人存储过程/function等评论标题看起来像（所以张贴您的例子）…我只真正看到了什么是SQL Serverpipe理工作室创build，但我对其他人的样子感兴趣…格式，使用的字符，程序信息/细节等我猜是真正使他们不同的… SQL Server Management Studio（版本9）存储过程注释标题默认值： — ============================================= — Author: Name — Create date: — Description: — =============================================

如何评论一个if-else结构？

可以说你有： if(condition) { i = 1; } else { i = 2; } 你需要把解释if和else块的意见。 什么是最可读的方式，让人们可以轻松地乍一看？ 我通常这样做： //check for condition if(condition) { i = 1; } else { //condition isn't met i = 2; } 我觉得这不是很好，因为评论是在不同的层面上的，所以你只要看看评论和else评论就会看起来像属于某种内部结构。 把他们这样的： if(condition) { //check for condition i = 1; } else { //condition isn't met i = 2; } 对我来说不好看，因为整个结构似乎没有评论（条件可能很大，需要多行）。 […]

是否有可能在模板Haskell中的函数生成评论？

在我们的项目中，我们有很多TH生成的函数。 向他们添加通用评论是有意义的，以便他们在Haddock / Hoogle中可见。 至less，“这是由TH产生的”。 是这样的可能吗？

C预处理器是否首先删除注释或扩展macros？

考虑这个（可怕的，糟糕的，不好的，非常糟糕的）代码结构： #define foo(x) // commented out debugging code // Misformatted to not obscure the point if (a) foo(a); bar(a); 我见过两个编译器的预处理器在这个代码上产生不同的结果： if (a) bar(a); 和 if (a) ; bar(a); 显然，这对于便携式代码库是一件坏事。 我的问题：预处理器应该怎么做？ 请先评论一下，或先扩展macros？

在XML中嵌套注释？

这些嵌套注释是否允许在XML文件中？ <!– Making only one observation attempting to correct the error code –> <!– <component> <!– Result observation template –> <!– <id root="2.16.840.1.113883.19.5.10" extension="103220"/> </component> –>

你如何标记代码，以便以后可以回来并进行处理？

在C＃中我使用#warning和#error指令， #warning This is dirty code… #error Fix this before everything explodes! 这样，编译器会让我知道我还有工作要做。 你用什么技术来标记代码，所以你不会忘记它？

在Vim的插入模式下，注释（＃）到行首

每当我想在vim中给一个缩进行添加一个注释，我就按下Shift – o （打开当前的新行，切换到插入模式），然后开始input一个Python注释（使用# ）。 然后，这个哈希值被神奇地移动到了行的开头（没有缩进），我必须点击几次tab。 任何人都知道如何解决它？

@see和@inheritDoc之间的区别细节

我已经看了JavaDoc的参考 ，虽然我了解@see （各种链接）和{@inheritDoc} （超类JavaDoc注释的导出）之间的基本区别，我需要澄清事情如何实际执行。 在Eclipse IDE中，当我为inheritance的方法（从接口，或toString（）覆盖等等）select“生成元素注释”时，会创build以下注释 /* (non-Javadoc) * @see SomeClass#someMethod() */ 如果我需要生成JavaDoc，我应该把它{@inheritDoc} ，用{@inheritDoc}replace@see ，或者把它转换成真正的 JavaDoc： /** * {@inheritDoc} */ 当我这样做的时候，我还应该保留class＃方法标志吗？

Javadoc：没有HTML标签的换行符？

对不起，有一个可能的常见问题types的问题，但我只是找不到答案。 就我所记得的Eclipse而言，Javadoc注释中的空行显示为（在内源Javadocpopup窗口中）作为换行符（具有额外的垂直间距）。 但是在Netbeans中，事实并非如此。 我可以configurationJavadoc将空行解释为换行符吗？ 额外的问题：我可以重写默认的NetBeans的行为（与此相关）源Javadocpopup窗口？ 我在说的是： 资源 /** * Paragraph One * * Paragraph Two */ void someMethod() { } Eclipse解释 Paragraph One Paragraph Two Netbeans的解释 Paragraph One Paragraph Two

如何在Visual Studio中添加高优先级的TODO注释？

添加如下所示的评论： // TODO: Refactor this code …在任务列表中创build一个我可以查看的任务等等! 可以让您按优先级sorting这些任务。 我如何设置一个特定的任务的优先级？