个人中心
文章发布
退出
作者热门文章
- iOS/Objective-C 元类和类别
- objective-c - -1001 错误，当 NSURLSession 通过 httpproxy 和/etc/hosts
- java - 使用网络类获取 url 地址
- ios - 推送通知中不播放声音
24
4
<分区>
我正在为我在 uni 的最后一年 CS 本科项目编写一个 Java 应用程序。在前几年，我们被告知必须对我们的代码使用 CheckStyle。但是，我发现使用默认的 CheckStyle 配置需要我为每件事编写一个 JavaDoc。即使是名称和实际代码足以描述那段代码的作用的明显实例字段和方法，也需要我编写 JavaDoc 注释。
老实说，我发现这是重复的，只会让我的代码困惑。如果没有所有这些评论，我会发现我的代码更具可读性和更短，这让我在需要查看类等时可以更好地了解。
问题是，如果 checkstyle 将它突出显示为一个问题(缺少 JavaDoc)并且我们被告知毫无异常(exception)地使用 CheckStyle，那么我怀疑我会失去分数，这是我最不想看到的。我引用这本优秀的书:马丁·罗伯特·C. (2008-08-01)。清洁代码:敏捷软件工艺手册(第 54 页)。培生教育(美国)。
The proper use of comments is to compensate for our failure to express ourself in code. Note that I used the word failure. I meant it. Comments are always failures. We must have them because we cannot always figure out how to express ourselves without them, but their use is not a cause for celebration. So when you find yourself in a position where you need to write a comment, think it through and see whether there isn’t some way to turn the tables and express yourself in code. Every time you express yourself in code, you should pat yourself on the back. Every time you write a comment, you should grimace and feel the failure of your ability of expression. Why am I so down on comments? Because they lie. Not always, and not intentionally, but too often. The older a comment is, and the farther away it is from the code it describes, the more likely it is to be just plain wrong. The reason is simple. Programmers can’t realistically maintain them.
我不能说我是多么全心全意地同意上述观点。这些评论在我眼里只是一团糟。在相关的地方，我有意见。
所以，我的问题归结为以下几点:我应该坚持自己的信念和阅读上述书籍获得的知识/建议，还是应该遵守 CheckStyle 标准并消除因缺乏而被打分的风险JavaDoc 评论？
24
4
0
这个问题在这里已经有了答案: 关闭 12 年前。 Possible Duplicate: Why can't Python handle true/false values as I expect?
我是不是遗漏了什么或者这是 ruby 中的错误？ a = %w(foo bar baz) a.include? "foo" # => true a.size == 3
从 Modelica 文档来看，注释 Evaluate 似乎只对参数有影响: https://build.openmodelica.org/Documentation/ModelicaReferenc
为了避免嵌套的 if 语句并提高可读性，我想创建一个switch(true){ ... } Coldfusion 中的声明。我在 php 中经常使用这个，但是当我在 Coldfusion 中尝试这个时
嗨，我正在尝试处理 ajax json 响应 这是我的代码 success: function (j) { switch(true) { case (j.cho
我之前在我的 TF 代码中使用过这个: count = "${var.whatever == "true" ? 1 : 0}" 这非常适合我想要使用的东西。但是，我正在考虑如何最好地使用类似于说的
我之前在我的 TF 代码中使用过这个: count = "${var.whatever == "true" ? 1 : 0}" 这非常适合我想要使用的东西。但是，我正在考虑如何最好地使用类似于说的
这个问题在这里已经有了答案: How can I return pivot table output in MySQL? (10 个答案) 关闭 5 年前。 我正在尝试构建一个以唯一列值作为列名的表
我制作了一个简单的 JDialog，其中包含一个标签和一个按钮，它基本上相当于信息对话框。所以在对话框中，有一个方法 display() 我在其中调用了 setVisible(true) 五次。 据我
在 bash 4.2.8(1)-release (x86_64-pc-linux-gnu) 在 Ubuntu 11.04 上这个命令 [ $(wc -l /var/www/some.log|cut -
我正在使用 c 语言进行并发处理，我有一个进程池。为此，我让每个 child 都在一个 While (True) 循环中。为了杀死 child ，我正在使用一个全局变量和一个信号处理程序来修改它来打破
我正在尝试选择填写了字段的数据库条目。数据库有两种插入数据的方式，一种输入评论，一种不输入，我希望只选择填写了评论的行。 $requete = "SELECT * FROM daysoff WHER
如何在 JavaMail session 中setDebug(true) 捕获流并在我的日志记录框架中使用它？ (缺少下载源代码，更改接受流作为参数的方法，重新编译它，...) 更一般地说，Java
我是 JavaScript 的新手，我刚刚发现了我无法理解的奇怪行为: var magicVar = Math.sin; magicVar == true; // it returns false m
对此感到困惑。 在两台服务器上运行相同版本的 MySQL。 (从完全相同的 rpm 构建)- 沿线的某个地方，一些开发人员改变了一些东西...... 服务器 1: mysql> select ( no
我在查看 OpenSSL 中使用的一些预处理器宏时，从 crypto/stack/safestack.h 中发现了以下内容: #define CHECKED_STACK_OF(type, p) \
所以我遇到了一个问题，我的正则表达式看起来像这样:/true|false/。 当我检查单词 falsee 时，我从这个正则表达式中得到一个 true，有没有办法将它限制为确切的 true 或 fals
我正在对这个恶意 JavaScript 行进行一些试验:var undefined = true; JavaScript 中每个未初始化的变量都有 undefined 的值，这只是一个保存特殊值 'u
我想将 PHP 的微时间存储为我在 MySQL 中的时间戳。 我去过told最好用 DECIMAL 存储它，但我找不到理想的大小。 有谁知道 microtime(true) 返回的最大大小是多少，所以
在 PHP 中，当您在 URL 中包含诸如“var=true”之类的内容时，URL 中的“true”和“false”是否被转换为 boolean 变量，或者它们是否等于文本“true”还是“假”？例如
我是一名优秀的程序员,十分优秀！