问题标签 [comments]

你如何解释你的队友对他们编写的代码进行注释的重要性？我知道有些程序员写的是情节评论，而另一些人则留下了很多期待，当你阅读评论时你会期待什么？

我一直在制作一个线程评论系统，作为正确学习 php 和 javascript/jquery 的一种方式。我过去做过一些零碎的工作，但我下定决心要好好学习它。

我无法将回复表单插入到正在回复的评论下方的评论树中。我知道这可能是非常基本的，但是当有人单击链接时，如何将 html 插入页面。

这段代码对我不起作用：

有人看到我哪里出错了吗？

我正在（用 C# 编写）一个简单的解析器来处理一种看起来很像经典 C 的脚本语言。

在我拥有的一个脚本文件中，我用来识别 /* 块注释 */ 的正则表达式正在进入某种无限循环，占用 100% 的 CPU 时间。

我正在使用的正则表达式是这样的：

关于为什么这可能会被锁定的任何建议？

或者，我可以使用什么其他正则表达式来代替？

更多信息：

• 在面向 .NET 3.5 的 C# 3.0 中工作；
• 我正在使用 Regex.Match(string,int) 方法在字符串的特定索引处开始匹配；
• 我已经让程序运行了一个多小时，但比赛还没有完成；
• 传递给 Regex 构造函数的选项是RegexOptions.Multilineand RegexOptions.IgnorePatternWhitespace;
• 正则表达式适用于我的 453 个测试文件中的 452 个。

我一直想知道为什么我必须在文本编辑器中编写富文本代码注释，也就是伪代码（来吧，粗体，下划线！）然后回到 IDE（集成？）来编写实际程序，更不用说确保这些文档位于代码附近。

所以问题是，如果 IDE 允许富文本代码注释会怎样。它会帮助任何人吗？考虑到您可以强调或强调重点并使用标题和子标题，也许会使模糊的图片更清晰易懂？

（是的，我知道我们可以使用 *important point* 和 ****** HEADER ****** 进行管理，但让我们暂时开箱即用！

我说的是集成在 IDE 中的 RTF 代码编辑器。

我正在阅读一堆使用 # （到行尾）注释的 MySQL 文件，但我的 sql-mode 不支持它们。我找到了定义 /**/ 和 -- 注释的 sql.el 的语法表部分，但据此， Emacs 语法表仅支持 2 种注释样式。

有没有办法在 sql.el 中轻松添加对 # 注释的支持？

我已经看到了几个标准，用于编写关于函数在 Python 中期望和返回的数据类型的注释。是否就哪一个是最佳实践达成共识？

http://www.python.org/dev/peps/pep-3107/中的新功能是我应该开始使用的吗？

我已经在 django-users 上发布了这个，但还没有收到回复！

所以我有自己的用户个人资料对象（用户的子类）。其中一个字段是 imagefield，它（显然）用于用户上传他们的徽标/缩略图。

问题是我如何将其包含在他们的评论中？

有任何想法吗？提前致谢！

复制

你对评论有什么硬性规定？

与我一起工作的开发人员对我感兴趣的评论有一些话要说（见下文）。你个人对评论的态度/看法是什么？

“我不会在代码中添加注释，除非它是一个简单的标题，或者存在
平台错误或不明显的必要解决方法。代码可以更改，注释可能会产生误导。代码
在使用时应该是自我记录的描述性名称及其逻辑
组织 - 及其解决方案应该是
执行给定任务的最干净/最简单的方法。如果程序员不能
仅通过阅读代码来判断程序做什么，那么他还没有准备好改变它
。往往是编写复杂或
不明显的东西的拐杖——我的目标是始终编写干净简单的代码。”

“我认为在评论方面有几个阵营，认为他们正在编写 API 和一些宏大的代码库的企业类型将用于子孙后代，类似工匠的程序员认为代码说明了什么它确实比注释更清晰，新手编写冗长/不清晰的代码以便需要给自己留下笔记，说明他们为什么要做某事。”

修改现有代码时使用了哪些特殊技术？

例如：假设您在方法中修改了业务规则。您是否用特殊注释标记修改的部分？

您在修改代码时使用的任何编码/注释标准？

从 PHP 文件中删除注释的最佳方法是什么？

我想做一些类似于 strip-whitespace() 的事情——但它也不应该删除换行符。

例如，

我要这个：

成为：

（尽管如果空行仍然保留在删除注释的位置，那就不行了。）

这可能是不可能的，因为需要保留嵌入的 HTML——这就是在谷歌上出现的问题。