Tag: 评论

XML评论和“ – ”

<!– here is some comment — ^ | what can be here apart from '>'? XML似乎不喜欢评论里面的“ – ”。 我在某处读到' – '在<! … > <! … >东西,但是(偶数–s)似乎也是无效的。 如果它是一些历史特征,什么是“亲”的一部分呢? (“反”部分无法在评论中)。 什么是评论处理变得复杂化的原因是不是仅仅以“ – >”结尾,而是允许“ – ”在里面?

如何说服人们评论他们的代码

说服别人评论他们的代码有什么好的理由? 我注意到很多程序员都喜欢编写代码的速度,而没有留下任何留给自己和其他人的文档的意见。 当我试着说服他们的时候,我会听到一些半熟的东西,比如“方法/class级名称应该说出来”等等。你会怎样改变他们的想法? 如果您反对评论,请留下评论。 这应该成为人们试图说服人们评论代码的资源,而不是其他方式。 🙂 其他相关的问题是: 评论代码 , 你评论你的代码 , 你如何评论你的意见 。

C ++函数注释的最佳实践

有没有公​​认的评论function的最佳做法? 我只知道doxygen风格,但它不是正式的C ++支持,就像Javadocs是Java的,所以只是想知道什么是最好的。

Python:在csv.DictReader中跳过标有#的注释行

使用csv.DictReader处理CSV文件非常好 – 但是我有CSV文件的注释行(在一行的开头用散列表示),例如: #步长= 1.61853 val0,VAL1,VAL2,杂交,温度,smattr 0.206895,0.797923,0.202077,0.631199,0.368801,0.311052,0.688948,0.597237,0.402763 -169.32,1,1.61853,2.04069e-92,1,0.000906546,0.999093,0.241356,0.758644,0.202382 #适应完了 csv模块不包含任何跳过这些行的方法 。 我可以很容易地做一些黑客行为,但是我想有一个很好的方法可以将csv.DicReader包装在其他一些迭代器对象的周围,这些对象会预处理以放弃行。

R:注释掉代码块

可能重复: R:多行注释变通办法? 我想在R中注释掉好几行代码。有什么办法可以不必在每行之前加一个#有点像/* blocked out code */在SAS中/* blocked out code */ ?

评论C#的inheritance(实际上是任何语言)

假设我有这个接口 public interface IFoo { ///<summary> /// Foo method ///</summary> void Foo(); ///<summary> /// Bar method ///</summary> void Bar(); ///<summary> /// Situation normal ///</summary> void Snafu(); } 和这个class级 public class Foo : IFoo { public void Foo() { … } public void Bar() { … } public void Snafu() { … } } 有没有办法,还是有一种工具,可以让我自动把每个成员在基类或接口的意见? 因为我讨厌为每个派生的子类重写相同的注释!

T4模板中的注释

这似乎是这样一个基本的问题,但我一直没能find一个MSDN文章或StackOverflow的问题,回答它:是否有可能在T4模板中的行注释或块注释? 我不想用注释生成代码(这很容易,直接),而是注释掉我的T4标记块。 那可能吗?

如何在JavaDocs中引用“* /”

我有一个需要包括*/在我的JavaDoc评论。 问题是,这也是closures评论的相同顺序。 引用/逃避这个的正确方法是什么? 例: /** * Returns true if the specified string contains "*/". */ public boolean containsSpecialSequence(String str) 跟进 :看来我可以使用/ 为斜线。 唯一的缺点是,当在文本编辑器中直接查看代码时,这不是完全可读的。 /** * Returns true if the specified string contains "*/". */

在HTML代码中使用HTML注释而不是使用HTML注释有什么好处?

我听到有人说有,所以我想知道。 HTML评论: <!– Comment goes here. –> PHP评论: <?php // Comment goes here. ?>

标准的windows .ini文件允许注释吗?

Windows ini文件中允许注释吗? (…假设你正在使用GetPrivateProfileString api函数来读取它们…) [Section] Name=Value ; comment ; full line comment 而且,在任何地方是否有适当的.INI文件格式? 谢谢你的答复 – 但是我可能不够清楚。 这只是我感兴趣的Windows API调用所读取的格式。我知道其他实现允许注释,但是它特别是我需要了解的MS Windows规范和实现。