坏味道--过多的注释(Comments) 特征 注释本身并不是坏事.但是常常有这样的情况:一段代码中出现长长的注释,而它之所以存在,是因为代码很糟糕. 问题原因 注释的作者意识到自己的代码不直观或不明显,所以想使用注释来说明自己的意图.这种情况下,注释就像是烂代码的除臭剂. 最好的注释是为函数或类起一个恰当的名字. 如果你觉得一个代码片段没有注释就无法理解,请先尝试重构,试着让所有注释都变得多余. 解决方法 如果一个注释是为了解释一个复杂的表达式,可以运用 提炼变量(Extract Variab…

comments库是django框架内置的评论库,可以快速搭建网站需要的评论系统.不过1.8的配置和1.6的出现了一点小小配置,由于刚刚接触,按照网上的文档配置,需要在 settings.py的INSTALLED_APPS中加入‘django.contrib.comments’,但是按照这个配置完成之后会出现一下错误: ImportError: No module named comments 开始一直以为是需要加载模块,但是添加模块之后依然有这个提示,后网上查阅发现原来1.8版本已经改了,参照…

"This file could not be checked in because the original version of the file on the server was moved or deleted. A new version of this file has been saved to the server, but your check-in comments were not saved---To save comments with the new version…

django 添加comments app 参看 django comments 文档 安装和配置comments 1.安装comments,运行:pip install django-contrib-comments命令 2.settings.py中做如下操作: INSTALLED_APPS下添加'django.contrib.sites' INSTALLED_APPS下添加'django_comments' 定义SITE_ID , SITE_ID = 1 3.令comments app生效…

三种comments: /* Test program */ int main() { // variable declaration int a, b, c; /* This is a test multiline comment for testing */ a = b + c; } import java.util.*; public class removeComments{ public static void main(String [] args){ String file = "…

ibatis中SAXParseException异常:The string "--" is not permitted within comments 这个异常是说sqlmap里面的注释不符合规范. 1. 这个问题之前看到过有一种解决方案,就是在注释结束前,也就是“–>”前面加一个英文半角的空格. 2. 今天发现了另外一个解决的方法,就是执行程序的时候加上jvm的参数 -Dfile.encoding=UTF8 这样子就算注释结束符前面不加空格也是可以的. 用eclipse的可以在…

Principle You must precede every exported class, interface, constructor, method, and field declaration with a doc comment. If a class is serializable, you should also document its serialized form (Item 75). To write maintainable code, you should also…

Document all functions, their arguments and return values, and also any interesting or unusual algorithm or technique. Think of the comments as hints to the future readers of the code; the readers need to understand what your code does without readin…

新装的ubuntu 10.04系统,使用新立得装的PHP,但是每次我在命令行下执行php脚本时都会出如下的警告信息: PHP Deprecated:  Comments starting with '#' are deprecated in /etc/php5/cli/conf.d/mcrypt.ini on line 1 in Unknown on line 0 上网查了一下,原来是新版本的PHP不赞成用'#'号作为注释符号,需要用分号';'.打开这个文件,把里面的#替换成;号,问题解决!…

http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html This document describes the style guide, tag and image conventions we use in documentation comments for Java programs written at Java Software, Oracle. It does not rehash r…