有没有在python中结束单行注释的方法？
就像是
/*This is my comment*/ some more code here...
评论被删除的代码是一个好习惯吗？例如:
// Code to do {task} was removed by Ajahn on 10/10/08 because {reason}.
在同行评审期间,我的开发人员小组中有人发表了一条说明,我们应该评论要删除的代码行.我认为这是一个可怕的建议,因为它用无用的评论使代码混乱.我们哪一个是对的？
我从来没有决定评论if-then-else结构的最佳方式,所以我从来没有标准化以一致的方式来评论它们.我很欣赏任何见解.
一些选择:
一个)
if (blabla) {
// this comment explains what happens in the IF case
dothis();
} else {
// this comment explains what happens in the ELSE case
dosomethingelse();
}
缺点:在多个dothis()语句的情况下,我喜欢评论主要块,在这种情况下,IF-comment是否属于第一个dothis()块或整个IF情况并不总是很清楚
或b)
if (blabla) { // this comment explains what happens in the IF case
dothis();
} else { // this comment explains what happens in the ELSE case
dosomethingelse();
}
缺点:仅适用于简短评论.如果IF和ELSE情况没有直接从代码中清除,我通常会注释IF-THEN-ELSE结构,这通常需要长于一行的注释.
或c)
// if the following happens
if (blabla) { // then do this
dothis(); …我知道PHP代码内联文档有许多不同的标准.这就是我对内联文档的意思,如果有更好的术语,请纠正我:
/**
* This is the description for the class below.
*
* @package my-package
* @subpackage my-subpackage
* @author my-name
* @version my-version
* ...
*/
class orderActions {
...
什么是最好和最广泛接受的内联文档形式？是否有任何工具可以自动生成此类文档,还是必须手动完成？
我对生成手册不感兴趣 - 我想知道如何生成上面注释的代码类型,或"内联文档".
何时在方法开头使用块注释,何时使用javadoc样式的注释是否合适？
从Java样式指南的"注释"部分,我发现了这个:
Java程序可以有两种注释:实现注释和文档注释.实现注释是在C++中找到的,由
/*...*//和// 分隔.文档注释(称为"文档注释")仅限Java,并由以下内容分隔/**...*/.可以使用javadoc工具将Doc注释提取到HTML文件.实现注释用于注释代码或有关特定实现的注释.Doc注释旨在从无实现的角度描述代码的规范.由可能不一定拥有源代码的开发人员阅读.
因此,另一种表达我的问题的方法是:方法何时应该从无实现的角度(Javadoc)而不是关于特定实现的注释来获得代码的规范,反之亦然？接口是否会获得javadoc注释,而实现会获得块注释？
编辑:我认为根据迄今为止的答案,我没有正确地传达我的问题.
这是我想知道的一个例子.
/**
* Javadoc comment here about general implementation?
*/
/*
* Should I now have a separate block comment for my specific implementation?
*/
public void foo()
{
...
}
两种不同的评论风格传达两种不同类型的信息.是否存在方法应该具有领先的javadoc注释和前导块注释的情况？
甚至要问的灵感就是Eclipse刚刚为我自动生成了这个:
/*
* (non-Javadoc)
* @see my.package#process()
*/
我认为这里有某种样式,我没有在上面链接的评论规范中明确声明.
我在Aptana Studio 3.0中找不到任何用于评论我的代码的快捷方式.我需要快捷方式来评论各行和评论选定的代码块.
有些人告诉我尝试用WIN + /我的Windows操作系统上的快捷方式发表评论,但这似乎不可行.
我需要一种方法将"Word样式"中的文本注释添加到Latex文档中.我不是要评论文档的源代码.我想要的是一种向文档添加更正,建议等的方法,这样它们就不会中断文本流,但这仍然可以让每个人都轻松地知道,它们与句子的哪一部分相关.编辑文档进行打印时,它们也应该"消失".
起初,我考虑过编写一个新命令,只是将输入转发给\marginpar{},并且在编译打印时只会使定义为空.问题是你不能保证评论会出现在哪里,你将无法区分它们marginpars.
任何的想法？
IntelliJ中是否有插件或工具可以删除源.java文件中的所有注释？我已经阅读了一个可以做到这一点的ANT任务 ..希望在IDE中做同样的事情.或者,TextPad插件也可以正常工作..
有没有办法在CSS中嵌套注释？
例如,当我尝试注释掉以下两个语句时,外部注释在遇到嵌套注释中的*/时结束,而第一个语句和第二个语句的其余部分取消注释.
/*
#container {
width: 90%; /* nested comment here */
margin: 0 auto;
}
#container .class {
width: 25%;
}
*/
当我想尝试涉及多个语句的不同样式技术时,我经常遇到这个问题.
我熟悉CSS 规范的注释及其基本原理,但也知道有一个嵌套HTML注释的解决方法,我希望有类似的CSS攻击.
有人找到了在CSS中嵌套注释的方法吗？
Ruby能够理解在线评论,例如:
my_array = ['first', /* 'second', */ 'third', 'fourth']
？
更新:
我没有询问Ruby中的/**/是什么以及我收到错误的原因,而是关于任何可用表单中的内嵌注释的存在./**/仅作为我所知的内联评论的示例.