标签: code-comments

如何在Xcode中为我自己的代码创建快速帮助条目？我只是想把它作为编码支持,就像编写Java时的Eclipse功能一样.在eclipse中,当您将方法悬停在其他位置时,您会在方法上方输入注释.

Xcode等效似乎是"快速帮助".

除了使用Doxygen之外真的没别的办法吗？对于我正在研究的小项目来说,Doxygen似乎有些过分.目前我确实知道我只想彻底填写快速帮助,所以请避免任何提示,"你必须为你的项目创建一个文档".

我真的很感激任何帮助,因为我在这个主题上唯一能找到的就是这个问题.

但正如您所看到的,没有可用的解决方案.

有这么好的理由吗？Lame问题,但我只是想知道是否有原因.

你如何在Perl正则表达式中放置注释？

重复

你评论的硬规则是什么？

我与之合作的开发人员有一些关于我感兴趣的评论的话题(见下文).您的个人做法/评论意见是什么？

"我不会在代码中添加注释,除非它是一个简单的标题,或者存在
平台错误或必要的解决方案,这是不明显的.代码可能会改变,注释可能会产生误导.代码应该
在使用时自我记录描述性的名称和其逻辑
的组织-和其解决方案应该是干净的/最简单的方法
,完成既定任务如果程序员不知道程序是什么
呢只阅读代码,那么他不准备改变它.
评论往往是写一些复杂
或非显而易见的东西- 我的目标是始终编写简洁明了的代码."

"我认为在评论方面存在一些阵营,那些认为他们正在编写API的企业级人员和一些将在未来几代使用的宏大代码库,这位工匠般的程序员认为代码说的是什么它比评论更清晰,并且新手编写详细/不清楚的代码,以便需要给自己留下笔记,告诉他们为什么要做某事."

我在R#社区论坛上问了同样的问题 ; 几天没有听到任何消息.以为我会重新发布SO.

对于C#的等号,XML注释中的间距的R#6设置在哪里？我已经浏览了R#设置中可以找到的所有代码格式化选项,但是每当我使用R#代码清理工具时,似乎都没有影响下面描述的间距问题.

在R#代码格式化之前:

/// <summary>
///  Writes trace information...
/// </summary>
/// <param name="eventCache">A <see cref="T:System.Diagnostics.TraceEventCache" /> object containing....</param>

在R#代码清理格式化之后:

/// <summary>
///   Writes trace information...
/// </summary>
/// <param name = "eventCache">A <see cref = "T:System.Diagnostics.TraceEventCache" /> object containing....</param>

注意'name'和'eventCache'之间等号周围的间距; 在'cref'和'T:System ......'之间

对于文档,我们通常必须创建一个附加文档,描述在代码中禁用任何lint消息时我们所做的操作(e.g. /* lint --e228).这将使它更容易使用doxygen(因为我们无论如何创建它).

虽然,我无法找到任何有关如何doxygen使用这些lint注释的解决方案.有没有人试过这个？是否有任何解决方案如何使用stric '/*lint'但无论如何添加它doxygen？

谢谢!

我已经看到了其他问题,但我仍然不满意这个主题的涵盖方式.

我想在代码检查中提取一个废弃的列表来检查注释.

我相信人们会说会相互抵消的事情.但是,嘿,也许我们可以为每个阵营建立一个清单.对于那些没有评论的人来说,这个名单会很短:)

我希望能够在每个查询的开头添加一个小注释,所以当我在进程列表或"mytop"中看到它时,我可以知道它在哪里运行.

这样的事情可能吗？

在我的一个项目上运行Sonar后,我发现了"尾随评论"的违规行为.所以我想知道,这是否与Java的接受/推荐的代码布局约定完全相关,还是"它还有更多"？背后的原因是什么？当我查看一些C++代码时(最近的Doom代码审查,有大量(或充满活页夹)的尾随注释.

我前段时间读过有关一种方法来评论一个css块的方法,你只需要删除注释字符集的一端,以防以后想要取消注释该块.

但我不记得它是如何完成的:(也许有人在这里知道:)