Tag: 评论

应用程序体系结构清单中应包含哪些内容？: 我试图想出一个清单或一组问题/标准来评估和评估提出的或新兴的体系结构（执行体系结构评估）。在尝试计划，评估或评估一个架构时，您提出的最重要的问题是什么？我知道这是一个很大的话题，所以我想把它限制在一个端到端的系统中，而不是整个组织的体系结构。 Code Complete提供了一个体面的起点： build筑程序的总体组织是否清晰，包括良好的架构概述和合理性？模块是否定义良好，包括其function和与其他模块的接口？这些要求中列出的所有function是否明智地涵盖了，既不是太多也不是太less的模块？这个架构是否适合可能的变化？是否需要购买与构build决策？架构是否描述了如何重用代码以符合其他架构目标？所有的主要数据结构都隐藏在访问例程之后吗？数据库的组织和内容是否合理？是否所有关键algorithm都被描述和certificate了？所有主要的对象都被描述和说明了吗？是否描述了处理用户input的策略？是处理I / O描述和合理化的策略？用户界面的关键方面是什么？用户界面是否被模块化，以便其中的更改不会影响程序的其余部分？内存使用估计和内存pipe理战略描述和合理化？架构是否为每个模块设置了空间和速度预算？处理string是一种策略吗？是string存储估计吗？是否提供了一致的error handling策略？是否将错误消息作为一个集合进行pipe理以呈现干净的用户界面？是否指定了一个健壮的级别？是否有任何部分超过或低于架构？这方面的期望是否明确？主要的系统目标是否明确说明？整个build筑在概念上是否一起挂？顶层devise是否独立于将用于实现它的机器和语言？是否提供了所有重大决策的动机？作为一名程序员，你是否会执行这个系统，对架构感到满意？我正在用实例来寻找实践知识，例如，您创build的架构中最痛苦的是什么？

Javadoc评论与块评论？: 什么时候在方法的开头使用块注释是合适的，什么时候使用javadoc风格的注释是合适的？从Java风格指南的“评论”部分，我发现这一点： Java程序可以有两种评论：实现评论和文档评论。实现注释是在C ++中find的，由/*…*/和//分隔。文档注释（被称为“doc注释”）是仅限于Java的，并由/**…*/分隔。可以使用javadoc工具将文档注释提取到HTML文件。实施意见是为了评论代码或对特定实施的评论。 Doc注释旨在从实现自由的angular度描述代码的规范。由可能不一定具有源代码的开发人员阅读。所以，另一种解释我的问题的方法是：何时应该从一个实现自由的angular度（Javadoc），而不是一个特定的实现的评论，而不是一个特定的实现的评论，应该得到一个规范的代码，反之亦然？会有一个接口获得javadoc评论，而实现获取块评论？编辑：我想我不是正确地传达我的问题，根据迄今为止的答案。这是我想知道的一个例子。 /** * Javadoc comment here about general implementation? */ /* * Should I now have a separate block comment for my specific implementation? */ public void foo() { … } 两种不同的评论风格传达了两种不同types的信息。有什么情况下，方法应该有一个领先的javadoc评论，并领先的块评论？甚至问的灵感是Eclipse自动生成这个对我来说刚才： /* * (non-Javadoc) * @see my.package#process() */ 而且我认为这里有一些样式，并没有在我上面链接的评论规范中明确声明。

如何评论XSLT而不是HTML: 我正在编写XSL，我想在整个代码中进行注释，在处理时会被剥离，比如PHP，但是我不知道如何。我知道这个评论对象，但是它在处理时打印出一个HTML注释。：\ <xsl:comment>comment</xsl:comment>

Python：如何在文件中读取时忽略＃注释行: 在Python中，我刚刚读了一个文本文件的行，我想知道如何编码，以忽略在行开头的散列＃注释。我认为这应该是这样的： for if line !contain # then …process line else end for loop 但我是Python的新手，我不知道这个语法

评论被删除的代码: 评论被删除的代码是否是一个好习惯？例如： // Code to do {task} was removed by Ajahn on 10/10/08 because {reason}. 我的开发人员在同行评审中发现有人注意到我们应该对要删除的代码行进行评论。我认为这是一个可怕的build议，因为它用无用的评论混淆了代码。我们哪一个是对的？

SQL中的多行注释分隔符是否与供应商无关？: 从SQL语句中编辑，build立或摘取樱桃时，我可以发现自己正在与四种stream行的数据库工具之一进行交互。我一直在求助于DB2和Informix的单行注释。我在vim中创build了macros来使这个效率稍微高一些，但是我想知道我是否工作太辛苦了。

Xcode将哪些源代码标识为标签？: 这主要是出于好奇的缘故。我知道有一段时间，Xcode能够以// TODO: Something I don't feel like doing now的forms识别注释// TODO: Something I don't feel like doing now 。将该行添加到文件的源代码将导致该TODO注释显示在Xcode的导航栏中：我最近也发现了这样一个forms的注释// MARK: Something可以达到与#pragma mark相同的效果。所以我可以写一个看起来像这样的评论： // MARK: – // MARK: Future Improvements: // TODO: Make something better // TODO: Fix some bug 而Xcode会像这样渲染出来：这导致我想知道：Xcode可以理解的其他types的评论，以改善项目导航？

如何使Facebook的评论小部件stream畅的宽度？: 是否有可能使Facebook的评论小部件stream畅的宽度？他们的文档显示了fb:comments xfbml或iframe的宽度字段，它被指定为：宽度 – 以像素为单位的插件宽度。最小build议宽度：400px。所以也许这是不可能的

Geany文本编辑评论: 有没有办法使用geany文本编辑器突出显示一段代码，以便将其注释掉？

如何在eclipse中更改@author标签configuration，使其具有我指定的名称？: 我正在使用Eclipse的Indigo for Java。我曾经写过评论的方法。在我使用@author标签时，它会自动获取当前login系统的用户名。我的问题是：我如何改变这个@author标签configuration的方式，它采用我指定的名称。我已经通过以下链接：如何更改Eclipse模板中使用的$ {user}variables的值但是它build议改变classpathvariables$user的值。我不想这样做。我想通过configuration更改评论模板。