标签: commenting

我记得在JavaScript教程中读到,通常最好避免使用单行注释,因为将来有人决定要压缩文件并删除所有空白区域.

PHP中的相同环是否正确？我是否应该使用多行注释,即使我只会占用一行,例如

echo $var; /*This code echoes a variable*/ 

或者在这种情况下使用单行评论是否可以？

PHP文件是通过删除空格来压缩的,还是有点极端？

我查看了iCal规范,但根本找不到任何东西.在过去的几天里,我已经通过谷歌搜索过几次了.

我发现有些人使用服务器端语言(主要是PHP)来读取.ics并删除多余的字符,因此这让我相信他们不受支持,因为他们正在删除额外的标记.

是否可以在.ics文件中包含注释？我不是在谈论组件属性.

编辑:经过更多的搜索,我得出的结论是,BEGIN:VCALENDAR和END:VCALENDAR之外的任何内容都可能会被忽略,从而使其成为评论.我导出了我的一个Google日历,手动添加了一些内容,并将其上传回来,没有明显的问题.有关这个想法的任何想法或经验？

我正在编写一个C++静态库,我一直在实现文件中使用doxygen注释进行评论.我从来没有真正关心文档,但我正在研究一些现在需要为用户做好记录的事情,而且我正在尝试替换我以前想要编码的坏习惯,而不是用更好的软件工程文档实践.

无论如何,前几天我意识到我需要一些不同类型的文档,一种类型的库用户(doxygen手册),然后评论我自己或未来的维护者,更多地处理实现细节.

我的解决方案之一是将文件,类和方法的doxygen注释放在实现文件的底部.在那里,它们将被排除在外,我可以在方法定义中/周围包含正常注释,以使程序员受益.我知道这是更多的工作,但它似乎是我实现两种不同类型的评论/文档的最佳方式.您是否同意或有任何可能有用的解决方案/原则.我浏览了网站,但无法找到任何处理此问题的线程.

另外,我真的不想在评论中丢失接口文件,因为我觉得最好让界面说明一切.如果用户需要更深入地了解库接口,我宁愿手册成为用户可以查看的地方.我在这里走在正确的轨道上吗？

任何想法或评论都非常感谢.

编辑:感谢大家的意见.我从听到他们那里学到了很多东西.我想我更好地理解如何将用户手册与对维护者有用的代码注释分开.我喜欢@jalf有关于"散文"风格手册的想法,该手册有助于解释如何使用该库.我真的认为这比参考手册更好.话虽如此......我也觉得参考手册可能真的派上用场了.我想我会将他的建议与其他人的想法结合起来并尝试创建一个混合体.(散文手册(使用doxygen标签,如页面,部分,小节)链接到参考手册.)我喜欢@jalf的另一个建议是没有整个手册插入其中的代码的想法.我可以通过将所有doxygen注释放在实现文件的底部来避免这种情况.这使得头文件清晰,实现干净,以便对维护实现的人发表有用的注释.我们将看看这是否真的有效.这些只是我对迄今学到的知识的看法.我不是肯定的,我的方法可以很好地运作,甚至可以实用.只有时间会给出答案.

我正在用PHP/MySQL构建一个评论系统.这个评论系统有一个很好的功能,它允许用户突出显示文本(在数据库中存储为"selected_text"),然后突出显示的文本将与用户发表的评论一起存储在数据库中.此外,我还将段落(突出显示的文本出现)存储为INT.这些值都存储在数据库中,但现在我想用它们做些什么.

我想创建"评论计数器".这些注释计数器将放在文章中每个段落的旁边,它们将显示对它们所附加的段落所做的注释总数."评论"的视觉概述:表格结构:

我尝试检索此信息的最新查询是:

$distinct = mysql_query("SELECT COUNT(DISTINCT paragraph_id) FROM comments");

和相应的PHP代码:

while ($result_three = mysql_fetch_array($distinct)) 
{ 
    echo $result_three['paragraph_id'];
}

现在,我想我可能会以错误的方式解决这个问题.我考虑过尝试运行首先查找所有内容的查询DISTINCT paragraph_ids.接下来,我会为每个循环运行一个计算出现次数的循环paragraph_ids.

我现在正在处理的查询似乎没有实现我的目标.此外,我担心我没有明确的方法将计算的数据明确地附加到"评论计数器".

我想添加多行表/列注释.

通常使用这个;

COMMENT ON TABLE USERS IS 'User table has the user data'

我需要的是一种在单引号内插入换行符的方法;

COMMENT ON TABLE USERS IS 'User table has the user data <smthg_here_for_new_line> 1- Name column has name <smthg_here_for_new_line> 2- Number Column has the id'

因此,表格评论将被视为;

User table has the user data
1- Name column has name
2- Number Column has the id

谁知道如何添加多行表/列注释？

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

例如:假设您修改方法中的业务规则.您是否使用特殊注释标记修改后的部分？

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

我是一个小型非营利组织的技术总监,我们正在建立一个新的网站.我们提出了几个不同主页设计的模型,需要收到董事会成员的意见.是否有在线应用程序/程序/框架将接收和组织用户评论？我正在寻找能够在查看页面时进行评论的内容,而不仅仅是留言板或维基.

这是我一直想知道的,所以这里.

在编写代码时,我/我被教导要分隔线,评论它们等......以提高可读性(正如我猜大多数人都是这样).我显然不认为这是一个任何问题,但它让我思考,如果所有这些空白和注释部分被编译器/解释器或其他任何东西忽略,这会对它的性能产生多大影响？

不可否认,我不太了解编译器的运行方式 - 只有基本概念.但是,我有一个公平的想法,一个人能够"忽略空白",它首先需要识别它(至少),这需要工作,因此需要时间.

那么我想,在极端水平的空白或评论呢？比方说,数百万或数十亿的部分？

我想我问的问题是:在什么时候(即极端级别)会忽略代码部分会影响编译器/解释器产生及时结果的能力,从而影响用户的体验？

谢谢.

我在这些地区有地区和各种方法.当我将XML注释添加到方法的顶部并折叠xml注释时,它会显示类似"/// ..."的内容,这是无效的.如何折叠时使其显示摘要标记内的内容.

VS 2008 Pro .NET 3.5 SP1

谢谢!

马特

我回顾了一些用Ruby编写的专业代码,没有发现任何评论.代码相当清楚,但不能自我记录.我应该期待专业编写的Ruby代码有评论吗？或者,是否有一些Ruby学说,评论不被认为是必要的？