初探

我们知道Javascript中的变量定义基本如下：

var name = 'Chen Hao';;
var email = 'haoel(@)hotmail.com';
var website = 'http://coolshell.cn';

如果要用对象来写的话，就是下面这个样子：

var chenhao = {
    name :'Chen Hao',
    email : 'haoel(@)hotmail.com',
    website : 'http://coolshell.cn'
};

于是，我就可以这样访问：

//以成员的方式
chenhao.name;
chenhao.email;
chenhao.website;

//以hash map的方式
chenhao["name"];
chenhao["email"];
chenhao["website"];

关于函数，我们知道Javascript的函数是这样的：

var doSomething = function(){
   alert('Hello World.');
};

于是，我们可以这么干：

var sayHello = function(){
   var hello = "Hello, I'm "+ this.name
                + ", my email is: " + this.email
                + ", my website is: " + this.website;
   alert(hello);
};

//直接赋值，这里很像C/C++的函数指针
chenhao.Hello = sayHello;

chenhao.Hello();

相信这些东西都比较简单，大家都明白了。 可以看到javascript对象函数是直接声明，直接赋值，直接就用了。runtime的动态语言。

还有一种比如规范的写法是：

//我们可以看到， 其用function来做class。
var Person = function(name, email, website){
    this.name = name;
    this.email = email;
    this.website = website;

    this.sayHello = function(){
        var hello = "Hello, I'm "+ this.name  + ", \n" +
                    "my email is: " + this.email + ", \n" +
                    "my website is: " + this.website;
        alert(hello);
    };
};

var chenhao = new Person("Chen Hao", "haoel@hotmail.com",
                                     "http://coolshell.cn");
chenhao.sayHello();

顺便说一下，要删除对象的属性，很简单：

delete chenhao['email']

上面的这些例子，我们可以看到这样几点：

Javascript的数据和成员封装很简单。

Javascript function中的this指针很关键，如果没有的话，那就是局部变量或局部函数。

Javascript对象成员函数可以在使用时临时声明，并把一个全局函数直接赋过去就好了。

Javascript的成员函数可以在实例上进行修改，也就是说不同的实例的同一个函数名的行为和实现不一样。

属性配置 – Object.defineProperty

先看下面的代码：

//创建对象
var chenhao = Object.create(null);

//设置一个属性
 Object.defineProperty( chenhao,
                'name', { value:  'Chen Hao',
                          writable:     true,
                          configurable: true,
                          enumerable:   true });

//设置多个属性
Object.defineProperties( chenhao,
    {
        'email'  : { value:  'haoel@hotmail.com',
                     writable:     true,
                     configurable: true,
                     enumerable:   true },
        'website': { value: 'http://coolshell.cn',
                     writable:     true,
                     configurable: true,
                     enumerable:   true }
    }
);

下面就说说这些属性配置是什么意思。

• writable：这个属性的值是否可以改。
• configurable：这个属性的配置是否可以改。
• enumerable：这个属性是否能在for…in循环中遍历出来或在Object.keys中列举出来。
• value：属性值。
• get()/set(_value)：get和set访问器。

Get/Set 选择器

关于get/set访问器，它的意思就是用get/set来取代value（其不能和value一起使用），示例如下：

var  age = 0;
Object.defineProperty( chenhao,
            'age', {
                      get: function() {return age+1;},
                      set: function(value) {age = value;}
                      enumerable : true,
                      configurable : true
                    }
);
chenhao.age = 100; //调用set
alert(chenhao.age); //调用get 输出101;

我们再看一个更为实用的例子——利用已有的属性(age)通过get和set构造新的属性(birth_year)：

Object.defineProperty( chenhao,
            'birth_year',
            {
                get: function() {
                    var d = new Date();
                    var y = d.getFullYear();
                    return ( y - this.age );
                },
                set: function(year) {
                    var d = new Date();
                    var y = d.getFullYear();
                    this.age = y - year;
                }
            }
);

alert(chenhao.birth_year);
chenhao.birth_year = 2000;
alert(chenhao.age);

这样做好像有点麻烦，你说，我为什么不写成下面这个样子：

var chenhao = {
    name: "Chen Hao",
    email: "haoel@hotmail.com",
    website: "http://coolshell.cn",
    age: 100,
    get birth_year() {
        var d = new Date();
        var y = d.getFullYear();
        return ( y - this.age );
    },
    set birth_year(year) {
        var d = new Date();
        var y = d.getFullYear();
        this.age = y - year;
    }

};
alert(chenhao.birth_year);
chenhao.birth_year = 2000;
alert(chenhao.age);

是的，你的确可以这样的，不过通过defineProperty()你可以干这些事：

1）设置如 writable，configurable，enumerable 等这类的属性配置。

2）动态地为一个对象加属性？比如：一些HTML的DOM对像。

查看对象属性配置

如果查看并管理对象的这些配置，下面有个程序可以输入这些东西：

//列出对象的属性.
function listProperties(obj)
{
    var newLine = "<br />";
    var names = Object.getOwnPropertyNames(obj);
    for (var i = 0; i < names.length; i++) {
        var prop = names[i];
        document.write(prop + newLine);

        // 列出对象的属性配置（descriptor）动用getOwnPropertyDescriptor函数。
        var descriptor = Object.getOwnPropertyDescriptor(obj, prop);
        for (var attr in descriptor) {
            document.write("..." + attr + ': ' + descriptor[attr]);
            document.write(newLine);
        }
        document.write(newLine);
    }
}

listProperties(chenhao);

call，apply， bind 和 this

关于Javascript的this指针，和C++/Java很类似。 我们来看个示例：（这个示例很简单了，我就不多说了）

function print(text){
    document.write(this.value + ' - ' + text+ '<br>');
}

var a = {value: 10, print : print};
var b = {value: 20, print : print};

print('hello');// this => global, output "undefined - hello"

a.print('a');// this => a, output "10 - a"
b.print('b'); // this => b, output "20 - b"

a['print']('a'); // this => a, output "10 - a"

我们再来看看call 和 apply，这两个函数的差别就是参数的样子不一样，另一个就是性能不一样，apply的性能要差很多。（关于性能，可到 JSPerf 上去跑跑看看）

print.call(a, 'a'); // this => a, output "10 - a"
print.call(b, 'b'); // this => b, output "20 - b"

print.apply(a, ['a']); // this => a, output "10 - a"
print.apply(b, ['b']); // this => b, output "20 - b"

但是在bind后，this指针，可能会有不一样，但是因为Javascript是动态的。如下面的示例

var p = print.bind(a);
p('a');             // this => a, output "10 - a"
p.call(b, 'b');     // this => a, output "10 - a"
p.apply(b, ['b']);  // this => a, output "10 - a"

继承 和 重载

通过上面的那些示例，我们可以通过Object.create()来实际继承，请看下面的代码，Student继承于Object。

var Person = Object.create(null);

Object.defineProperties
(
    Person,
    {
        'name'  : {  value: 'Chen Hao'},
        'email'  : { value : 'haoel@hotmail.com'},
        'website': { value: 'http://coolshell.cn'}
    }
);

Person.sayHello = function (person) {
    var hello = "<p>Hello, I am "+ this.name  + ", <br>" +
                "my email is: " + this.email + ", <br>" +
                "my website is: " + this.website;
    document.write(hello + "<br>");
}

var Student = Object.create(Person);
Student.no = "1234567"; //学号
Student.dept = "Computer Science"; //系

//检查Person的属性
document.write(Student.name + ' ' + Student.email + ' ' + Student.website +'<br>');

//检查Person的方法
Student.sayHello();

//重载SayHello方法
Student.sayHello = function (person) {
    var hello = "<p>Hello, I am "+ this.name  + ", <br>" +
                "my email is: " + this.email + ", <br>" +
                "my website is: " + this.website + ", <br>" +
                "my student no is: " + this. no + ", <br>" +
                "my departent is: " + this. dept;
    document.write(hello + '<br>');
}
//再次调用
Student.sayHello();

//查看Student的属性（只有 no 、 dept 和 重载了的sayHello）
document.write('<p>' + Object.keys(Student) + '<br>');

通用上面这个示例，我们可以看到，Person里的属性并没有被真正复制到了Student中来，但是我们可以去存取。这是因为Javascript用委托实现了这一机制。其实，这就是Prototype，Person是Student的Prototype。

当我们的代码需要一个属性的时候，Javascript的引擎会先看当前的这个对象中是否有这个属性，如果没有的话，就会查找他的Prototype对象是否有这个属性，一直继续下去，直到找到或是直到没有Prototype对象。

为了证明这个事，我们可以使用Object.getPrototypeOf()来检验一下：

Student.name = 'aaa';

//输出 aaa
document.write('<p>' + Student.name + '</p>');

//输出 Chen Hao
document.write('<p>' +Object.getPrototypeOf(Student).name + '</p>');

于是，你还可以在子对象的函数里调用父对象的函数，就好像C++里的 Base::func() 一样。于是，我们重载hello的方法就可以使用父类的代码了，如下所示：

//新版的重载SayHello方法
Student.sayHello = function (person) {
    Object.getPrototypeOf(this).sayHello.call(this);
    var hello = "my student no is: " + this. no + ", <br>" +
                "my departent is: " + this. dept;
    document.write(hello + '<br>');
}

这个很强大吧。

组合

上面的那个东西还不能满足我们的要求，我们可能希望这些对象能真正的组合起来。为什么要组合？因为我们都知道是这是OO设计的最重要的东西。不过，这对于Javascript来并没有支持得特别好，不好我们依然可以搞定个事。

首先，我们需要定义一个Composition的函数：（target是作用于是对象，source是源对象），下面这个代码还是很简单的，就是把source里的属性一个一个拿出来然后定义到target中。

function Composition(target, source)
{
    var desc  = Object.getOwnPropertyDescriptor;
    var prop  = Object.getOwnPropertyNames;
    var def_prop = Object.defineProperty;

    prop(source).forEach(
        function(key) {
            def_prop(target, key, desc(source, key))
        }
    )
    return target;
}

有了这个函数以后，我们就可以这来玩了：

//艺术家
var Artist = Object.create(null);
Artist.sing = function() {
    return this.name + ' starts singing...';
}
Artist.paint = function() {
    return this.name + ' starts painting...';
}

//运动员
var Sporter = Object.create(null);
Sporter.run = function() {
    return this.name + ' starts running...';
}
Sporter.swim = function() {
    return this.name + ' starts swimming...';
}

Composition(Person, Artist);
document.write(Person.sing() + '<br>');
document.write(Person.paint() + '<br>');

Composition(Person, Sporter);
document.write(Person.run() + '<br>');
document.write(Person.swim() + '<br>');

//看看 Person中有什么？（输出：sayHello,sing,paint,swim,run）
document.write('<p>' + Object.keys(Person) + '<br>');

Prototype 和 继承

我们先来说说Prototype。我们先看下面的例程，这个例程不需要解释吧，很像C语言里的函数指针，在C语言里这样的东西见得多了。

var plus = function(x,y){
    document.write( x + ' + ' + y + ' = ' + (x+y) + '<br>');
    return x + y;
};

var minus = function(x,y){
    document.write(x + ' - ' + y + ' = ' + (x-y) + '<br>');
    return x - y;
};

var operations = {
    '+': plus,
    '-': minus
};

var calculate = function(x, y, operation){
    return operations[operation](x, y);
};

calculate(12, 4, '+');
calculate(24, 3, '-');

那么，我们能不能把这些东西封装起来呢，我们需要使用prototype。看下面的示例：

var Cal = function(x, y){
    this.x = x;
    this.y = y;
}

Cal.prototype.operations = {
    '+': function(x, y) { return x+y;},
    '-': function(x, y) { return x-y;}
};

Cal.prototype.calculate = function(operation){
    return this.operations[operation](this.x, this.y);
};

var c = new Cal(4, 5);

Cal.calculate('+');
Cal.calculate('-');

这就是prototype的用法，prototype 是javascript这个语言中最重要的内容。网上有太多的文章介始这个东西了。说白了，prototype就是对一对象进行扩展，其特点在于通过“复制”一个已经存在的实例来返回新的实例,而不是新建实例。被复制的实例就是我们所称的“原型”，这个原型是可定制的（当然，这里没有真正的复制，实际只是委托）。上面的这个例子中，我们扩展了实例Cal，让其有了一个operations的属性和一个calculate的方法。

这样，我们可以通过这一特性来实现继承。还记得我们最最前面的那个Person吧， 下面的示例是创建一个Student来继承Person。

function Person(name, email, website){
    this.name = name;
    this.email = email;
    this.website = website;
};

Person.prototype.sayHello = function(){
    var hello = "Hello, I am "+ this.name  + ", <br>" +
                "my email is: " + this.email + ", <br>" +
                "my website is: " + this.website;
    return hello;
};

function Student(name, email, website, no, dept){
    var proto = Object.getPrototypeOf;
    proto(Student.prototype).constructor.call(this, name, email, website);
    this.no = no;
    this.dept = dept;
}

// 继承prototype
Student.prototype = Object.create(Person.prototype);

//重置构造函数
Student.prototype.constructor = Student;

//重载sayHello()
Student.prototype.sayHello = function(){
    var proto = Object.getPrototypeOf;
    var hello = proto(Student.prototype).sayHello.call(this) + '<br>';
    hello += "my student no is: " + this. no + ", <br>" +
             "my departent is: " + this. dept;
    return hello;
};

var me = new Student(
    "Chen Hao",
    "haoel@hotmail.com",
    "http://coolshell.cn",
    "12345678",
    "Computer Science"
);
document.write(me.sayHello());

兼容性

上面的这些代码并不一定能在所有的浏览器下都能运行，因为上面这些代码遵循 ECMAScript 5 的规范，关于ECMAScript 5 的浏览器兼容列表，你可以看这里“ES5浏览器兼容表”。

本文中的所有代码都在Chrome最新版中测试过了。

下面是一些函数，可以用在不兼容ES5的浏览器中：

Object.create()函数

function clone(proto) {
    function Dummy() { }

    Dummy.prototype             = proto;
    Dummy.prototype.constructor = Dummy;

    return new Dummy(); //等价于Object.create(Person);
}

var me = clone(Person);

defineProperty()函数

function defineProperty(target, key, descriptor) {
    if (descriptor.value){
        target[key] = descriptor.value;
    }else {
        descriptor.get && target.__defineGetter__(key, descriptor.get);
        descriptor.set && target.__defineSetter__(key, descriptor.set);
    }

    return target
}

keys()函数

function keys(object) { var result, key
    result = [];
    for (key in object){
        if (object.hasOwnProperty(key))  result.push(key)
    }

    return result;
}

Object.getPrototypeOf() 函数

function proto(object) {
    return object?            object.__proto__
         : /* not object? */  null
}

参考

• W3CSchool
• MDN (Mozilla Developer Network)
• MSDN (Microsoft Software Development Network)

http://coolshell.cn/articles/6441.html

The topLink jQuery plugin developed by David Walsh, allows you to fade in a “to the top” link when the users scrolls down on the page.

This tutorial will help you build a scroll to top link, that appears when the user scrolls down, and disappears when users reach the top of the page using a combination of CSS and jQuery.

Here’s a simple Scroll to Top button that hovers in the bottom right corner of your screen. he code is largely adapted from Brian Cray and David Walsh, but it’s a combination of the two ideas with the addition of a fade effect on the button and smooth scrolling action.

Here’s an unobtrusive, easy-to-install, jQuery script that adds a fading scroll to top link with animated scrolling. the script degrades gracefully, leaving nothing but a normal <a href > link.

Inspired by the great idea of David Walsh’s jQuery topLink Plugin, Matt Varone made a similar plugin but with two key differences, this one does not require you to add extra html markup or extra plugins to function. It will only work when JavaScript is turned on.

This script displays a stationary control at the lower right corner of the window that when clicked on gently scrolls the page back up to the top. Instead of always being visible on the user’s screen, the script lets you specify how far down the page the user is at (in pixels) before revealing the control.

1上传歌曲，如图:

2上传好歌曲列表页面顶部地址复制id=部分后的785AFBBC20E026A6%21121

3放在http://storage.live.com/items/后得到地址http://storage.live.com/items/785AFBBC20E026A6%21121

在新页面打开得到一个如图的xml文本

4我们需要对应歌曲的ResourceID和RelationshipName部分。

我们上传的歌曲Mix 的ResourceID是 785AFBBC20E026A6!126

RelationshipName是Mix.mp3

skydrive外链音乐格式为http://storage.live.com/items/ResourceID/?RelationshipName

这样我们上传的Mix最后的地址就是

http://storage.live.com/items/785AFBBC20E026A6!126?Mix.mp3

转自：http://www.lqcc.info/sharing-pioneer/how-to-get-music-outside-the-chain-of-skydrive.html

Nivo Slider是世界知名的轻量级jQuery图片幻灯片插件，可以制作出很漂亮的效果。它完全免费且彻底开源。

2. Sponsor Flip Wall With jQuery & CSS

Sponsor Flip Wall是一个非常不错的显示数据到网格里的插件，它使用PHP、CSS与jQuery翻转插件制作而成，其实就是为了创建一个翻转赞助商页面。可以用来展示你的客户或生成一个整洁的翻转动画组合项目。 

3. PhotoSwipe

PhotoSwipe是一个免费的基于HTML/CSS/j的图片画廊插件，尤其可用于移动设备。

4. TN3 Gallery

TN3 Gallery也是一个jQuery图片画廊和幻灯片展示插件，支持多种转换效果及多相簿选项，可定制CSS皮肤等。它适用于所有的桌面及移动浏览器。

5. SIDEWAYS – jQuery fullscreen image gallery

一个简单而又飘逸的全屏图片画廊插件，由jQuery框架及一些简单的CSS创建。

6. Moleskine Notebook with jQuery Booklet

在这篇文章中，你可以学习到如何设计一个虚拟的Moleskine笔记本。

7. Orbit: A Slick jQuery Image Slider Plugin

Orbit是由ZURB开发的一个jQuery幻灯片插件。该插件非常轻量级（只有4KB），容易使用且拥有许多好功能。

8. Exposure

Exposure是一个图片预览插件，用于创建丰富、自定义的视觉体验，可以处理海量数据。

　　整洁和有组织的垂直导航。惊人的漂亮图片和颜色！

Weightshift

　　很酷的使用菜单导航，优雅！

Don’t throw Batteries

　　优雅整洁的菜单

FA Design

　　Another great example of typography based menu.

Album Art Collection

　　Amazing layout, navigation and menu.

Polyester Studio

　　Awesome colours with integrated menu and flow. It never gets boring.

Doopsuiker Poppies

　　Pretty menu, nice flow and navigation.

simpleasmilk.co.uk

　　Good typography based layout and menu with really cool colors and nice flow.

IWC

　　Neat grid navigation layout with a graceful menu.

Prince Street Films

　　Pretty good layout, colors and typography.

Comic Sans Criminal

　　Horizontal vertical, based on typography and a good color scheme.

Above the Fold

　　Awesome vertical navigation. You can scroll it down or select an option at the menu — both ways it is good.

ACC Media

　　Great horizontal navigation totally based on images.

Futurefabric

　　Simple structure with scroll based navigation and beautiful menu. Simplicity is the beauty.

polargold

　　Simply hover and then click the menu you wish to open. Simple and beautiful.

Helmy Bern

　　This website has a combo hover + dropdown, which is always interesting and cool.

Voltage

　　Large typography that gets noticed and then it fades when you are not checking out the respective menu.

Ecoforms

　　Pretty layout and colors. Use image slider or menu to navigate easily.

Keith Homemade Cakes

　　Beautiful layout and images with easy navigation.

Javascript für Designer

　　Vertical navigation with amazing color scheme and forms.

Ed Nacional

　　Neat and clean layout with eye catching images and navigation.

Marco Rotoli

　　Use the sliders, sideways and upside down, or menus for extremely easy navigation.

Makr Carry Goods

　　Extremely neat layout and navigation.

Pentagram

　　Navigate using the horizontal sliders, images or the dropdowns. Really nice.

Keenan Wells

　　Great navigation. All you have to do is to choose what do you wish to see in the top right corner and then just go with the flow. A horizontal slider is also present to see previous projects.

TROZO GALLERY

Biola Undergrad

1. 交互式相片桌面，使用 jQuery 和 CSS3 开发

Demo Download

　　2. 相册缩略图导航

Demo Download

　　3. 最小化的滑动展示相册

Demo Download

　　4. 独特的相册，使用 z-index 和 jQuery 开发

Demo Download

　　5. 宝丽来相片浏览

Demo Download

　　6. Photoshoot plug-in

Demo Download

　　7. Revealing Slider

Demo Download

2，打开Error Reporting

Error reporting 在 PHP 开发时是很有帮助的. 你可以在你代码中发现先前你没有发现的错误，因为并不是所有的BUG都会让程序运行不了的。当产品正式使用时，才有必要关掉错误报告，不然顾客看到一堆奇怪的字符不知道那是什么意思。

3，使用IDE

IDE (集成开发环境，Integrated Development Environments)对于开发者来说是很有帮助的工具.

荒野在这里推荐netbeans IDE 。

4. 试着使用一个PHP 框架

5.学习DRY方法

DRY 代表 Don’t Repeat Yourself，它是一个有价值的编程概念，不管是什么语言。DRY编程，顾名思义，是确保你不写多余的代码。

6.使用空格缩进代码来提高可读性

7. “Tier” your Code

给你的应用程序分层，分成不同部位的不同组成部分的代码。这使得您可以轻松地在未来改变你的代码。 如常用的MVC模式。

8. 总是使用 <?php ?>

9.使用有意义的，一致的命名约定

10.注释、注释、注释

11.安装MAMP/WAMP

12.给你的脚本限制运行时间

通常PHP脚本的运行时间被限制为30秒，超过这个时间PHP将抛出一个致命错误。

13.使用OOP

14.知道双引号和单引号的不同

15.不要在网站的根目录放phpinfo()

16.永远不要信任你的用户

17.加密存储密码

Rebuttal:

Keep in mind, however, that MD5 hashes have long since been compromised. They’re absolutely more secure than not, but, with the use of an enormous “rainbow table,” hackers can cross reference your hash. To add even more security, consider adding a salt as well. A salt is basically an additional set of characters that you append to the user’s string.

18.使用可视化数据库设计工具

如 DBDesigner 和 MySQL Workbench

19.使用输出缓冲

Rebuttal: Though not required, it’s generally considered to be a good practice to go ahead and append the “ob_end_flush();” function as well to the bottom of the document. P.S. Want to compress the HTML as well? Simply replace “ob_start();” with “ob_start(‘ob_gzhandler’)”;

Refer to this Dev-tips article for more information.

20.保护你的代码避免SQL注射

By using prepared statements, we never embed the user’s inputted data directly into our query. Instead, we use the “bind_param” method to bind the values (and escaping) to the query. Much safer, and, notably, faster when executing multiple CRUD statements at once.

21.尝试ORM　（object relational mapping）

ORM libraries for PHP like Propel, and ORM is built into PHP frameworks like CakePHP.

22.缓存数据库驱动页面

如：

23.使用缓存系统

• Memcached
• APC
• XCache
• Zend Cache
• eAccelerator

24.验证Cookie数据

Cookie data, like any data passed on the Web, can be harmful. You can validate cookie data with either the htmlspecialchars() or mysql_real_escape_string().

25.使用静态文件缓存系统

如Smarty的是一个内置缓存的强大的模板系统。

26.分析你的代码

Profiling your code with a tool like xdebug can help you to quickly spot bottlenecks and other potential problems in your PHP code. Some IDEs like Netbeans have PHP profiling capabilities as well.

27.编码标准

如 http://net.tutsplus.com/tutorials/php/30-php-best-practices-for-beginners/

对于网页开发者来说，学会jQuery是必要的。因为它让你了解业界最通用的技术，为将来学习更高级的库打下基础，并且确实可以很轻松地做出许多复杂的效果。

虽然jQuery上手简单，比其他库容易学会，但是要全面掌握，却不轻松。因为它涉及到网页开发的方方面面，提供的各种方法和内部变化有上千种之多。初学者常常感到，入门很方便，提高很困难。

目前，互联网上最好的jQuery入门教材，是Rebecca Murphey写的《jQuery基础》（jQuery Fundamentals）。在Google里搜索”jQuery 培训”，此书排在第一位。jQuery官方团队已经同意，把此书作为官方教程的基础。

这本书虽然是入门教材，但也足足有100多页。我对它做了一个详细的笔记，试图理清jQuery的设计思想，找出学习的脉络。我的目标是全面掌握jQuery，遇到问题的时候，心里有底，基本知道使用它的哪一个功能，然后可以迅速从手册中找到具体的写法。

下面就是我的笔记，它应该是目前网上不多的jQuery中文教程之一。你只需要一点javascript语言的基本知识，就能看懂它，在最短的时间里，掌握jQuery的所有主要方面（除了ajax和插件开发）。

===========================================

jQuery设计思想

原文网址：http://jqfundamentals.com/book/

阮一峰 翻译整理

【目录】

一、选择网页元素

二、改变结果集

三、链式操作

四、元素的操作：取值和赋值

五、元素的操作：移动

六、元素的操作：复制、删除和创建

七、工具方法

八、事件操作

九、特殊效果

【正文】

一、选择网页元素

jQuery的基本设计和主要用法，就是“选择某个网页元素，然后对其进行某种操作”。这是它区别于其他函数库的根本特点。

使用jQuery的第一步，往往就是将一个选择表达式，放进构造函数jQuery()（简写为$），然后得到被选中的元素。

选择表达式可以是CSS选择器：

　　$(document) //选择整个文档对象

$(‘#myId’) //选择ID为myId的网页元素

$(‘div.myClass’) // 选择class为myClass的div元素

$(‘input[name=first]‘) // 选择name属性等于first的input元素

也可以是jQuery特有的表达式：

　　$(‘a:first’) //选择网页中第一个a元素

$(‘tr:odd’) //选择表格的奇数行

$(‘#myForm :input’) // 选择表单中的input元素

$(‘div:visible’) //选择可见的div元素

$(‘div:gt(2)’) // 选择所有的div元素，除了前三个

$(‘div:animated’) // 选择当前处于动画状态的div元素

二、改变结果集

如果选中多个元素，jQuery提供过滤器，可以缩小结果集：

　　$(‘div’).has(‘p’); // 选择包含p元素的div元素

$(‘div’).not(‘.myClass’); //选择class不等于myClass的div元素

$(‘div’).filter(‘.myClass’); //选择class等于myClass的div元素

$(‘div’).first(); //选择第1个div元素

$(‘div’).eq(5); //选择第6个div元素

有时候，我们需要从结果集出发，移动到附近的相关元素，jQuery也提供了在DOM树上的移动方法：

　　$(‘div’).next(‘p’); //选择div元素后面的第一个p元素

$(‘div’).parent(); //选择div元素的父元素

$(‘div’).closest(‘form’); //选择离div最近的那个form父元素

$(‘div’).children(); //选择div的所有子元素

$(‘div’).siblings(); //选择div的同级元素

三、链式操作

选中网页元素以后，就可以对它进行某种操作。

jQuery允许将所有操作连接在一起，以链条的形式写出来，比如：

　　$(‘div’).find(‘h3′).eq(2).html(‘Hello’);

分解开来，就是下面这样：

　　$(‘div’) //找到div元素

.find(‘h3′) //选择其中的h3元素

.eq(2) //选择第3个h3元素

.html(‘Hello’); //将它的内容改为Hello

这是jQuery最令人称道、最方便的特点。它的原理在于每一步的jQuery操作，返回的都是一个jQuery对象，所以不同操作可以连在一起。

jQuery还提供了.end()方法，使得结果集可以后退一步：

　　$(‘div’)

.find(‘h3′)

.eq(2)

.html(‘Hello’)

.end() //退回到选中所有的h3元素的那一步

.eq(0) //选中第一个h3元素

.html(‘World’); //将它的内容改为World

四、元素的操作：取值和赋值

操作网页元素，最常见的需求是取得它们的值，或者对它们进行赋值。

jQuery使用同一个函数，来完成取值（getter）和赋值（setter）。到底是取值还是赋值，由函数的参数决定。

　　$(‘h1′).html(); //html()没有参数，表示取出h1的值

$(‘h1′).html(‘Hello’); //html()有参数Hello，表示对h1进行赋值

常见的取值和赋值函数如下：

　　.html() 取出或设置html内容

.text() 取出或设置text内容

.attr() 取出或设置某个属性的值

.width() 取出或设置某个元素的宽度

.height() 取出或设置某个元素的高度

.val() 取出某个表单元素的值

需要注意的是，如果结果集包含多个元素，那么赋值的时候，将对其中所有的元素赋值；取值的时候，则是只取出第一个元素的值（.text()例外，它取出所有元素的text内容）。

五、元素的操作：移动

如果要移动选中的元素，有两种方法：一种是直接移动该元素，另一种是移动其他元素，使得目标元素达到我们想要的位置。

假定我们选中了一个div元素，需要把它移动到p元素后面。

第一种方法是使用.insertAfter()，把div元素移动p元素后面：

　　$(‘div’).insertAfter(‘p’);

第二种方法是使用.after()，把p元素加到div元素前面：

　　$(‘p’).after(‘div’);

表面上看，这两种方法的效果是一样的，唯一的不同似乎只是操作视角的不同。但是实际上，它们有一个重大差别，那就是返回的元素不一样。第一种方法返回div元素，第二种方法返回p元素。你可以根据需要，选择到底使用哪一种方法。

使用这种模式的操作方法，一共有四对：

　　.insertAfter()和.after()：在现存元素的外部，从后面插入元素

.insertBefore()和.before()：在现存元素的外部，从前面插入元素

.appendTo()和.append()：在现存元素的内部，从后面插入元素

.prependTo()和.prepend()：在现存元素的内部，从前面插入元素

六、元素的操作：复制、删除和创建

复制元素使用.clone()。

删除元素使用.remove()和.detach()。两者的区别在于，前者不保留被删除元素的事件，后者保留，有利于重新插入文档时使用。

清空元素内容（但是不删除该元素）使用.empty()。

创建新元素的方法非常简单，只要把新元素直接传入jQuery的构造函数就行了：

　　$(‘<p>Hello</p>’);

$(‘<li class=”new”>new list item</li>’);

$(‘ul’).append(‘<li>list item</li>’);

七、工具方法

除了对选中的元素进行操作以外，jQuery还提供一些工具方法（utility），不必选中元素，就可以直接使用。

如果你懂得Javascript语言的继承原理，那么就能理解工具方法的实质。它是定义在jQuery构造函数上的方法，即jQuery.method()，所以可以直接使用。而那些操作元素的方法，是定义在构造函数的prototype对象上的方法，即jQuery.prototype.method()，所以必须生成实例（即选中元素）后使用。如果不理解这种区别，问题也不大，只要把工具方法理解成，是像javascript原生函数那样，可以直接使用的方法就行了。

常用的工具方法有以下几种：

　　$.trim() 去除字符串两端的空格。

$.each() 遍历一个数组或对象。

$.inArray() 返回一个值在数组中的索引位置。如果该值不在数组中，则返回-1。

$.grep() 返回数组中符合某种标准的元素。

$.extend() 将多个对象，合并到第一个对象。

$.makeArray() 将对象转化为数组。

$.type() 判断对象的类别（函数对象、日期对象、数组对象、正则对象等等）。

$.isArray() 判断某个参数是否为数组。

$.isEmptyObject() 判断某个对象是否为空（不含有任何属性）。

$.isFunction() 判断某个参数是否为函数。

$.isPlainObject() 判断某个参数是否为用”{}”或”new Object”建立的对象。

$.support() 判断浏览器是否支持某个特性。

八、事件操作

jQuery可以对网页元素绑定事件。根据不同的事件，运行相应的函数。

　　$(‘p’).click(function(){

alert(‘Hello’);

});

目前，jQuery主要支持以下事件：

　　.blur() 表单元素失去焦点。

.change() 表单元素的值发生变化

.click() 鼠标单击

.dblclick() 鼠标双击

.focus() 表单元素获得焦点

.focusin() 子元素获得焦点

.focusout() 子元素失去焦点

.hover() 同时为mouseenter和mouseleave事件指定处理函数

.keydown() 按下键盘（长时间按键，只返回一个事件）

.keypress() 按下键盘（长时间按键，将返回多个事件）

.keyup() 松开键盘

.load() 元素加载完毕

.mousedown() 按下鼠标

.mouseenter() 鼠标进入（进入子元素不触发）

.mouseleave() 鼠标离开（离开子元素不触发）

.mousemove() 鼠标在元素内部移动

.mouseout() 鼠标离开（离开子元素也触发）

.mouseover() 鼠标进入（进入子元素也触发）

.mouseup() 松开鼠标

.ready() DOM加载完成

.resize() 浏览器窗口的大小发生改变

.scroll() 滚动条的位置发生变化

.select() 用户选中文本框中的内容

.submit() 用户递交表单

.toggle() 根据鼠标点击的次数，依次运行多个函数

.unload() 用户离开页面

以上这些事件在jQuery内部，都是.bind()的便捷方式。使用.bind()可以更灵活地控制事件，比如为多个事件绑定同一个函数：

　　$(‘input’).bind(

‘click change’, //同时绑定click和change事件

function() {

alert(‘Hello’);

}

);

有时，你只想让事件运行一次，这时可以使用.one()方法。

　　$(“p”).one(“click”, function() {

alert(“Hello”); //只运行一次，以后的点击不会运行

});

.unbind()用来解除事件绑定。

　　$(‘p’).unbind(‘click’);

所有的事件处理函数，都可以接受一个事件对象（event object）作为参数，比如下面例子中的e：

　　$(“p”).click(function(e) {

alert(e.type); // “click”

});

这个事件对象有一些很有用的属性和方法：

　　event.pageX 事件发生时，鼠标距离网页左上角的水平距离

event.pageY 事件发生时，鼠标距离网页左上角的垂直距离

event.type 事件的类型（比如click）

event.which 按下了哪一个键

event.data 在事件对象上绑定数据，然后传入事件处理函数

event.target 事件针对的网页元素

event.preventDefault() 阻止事件的默认行为（比如点击链接，会自动打开新页面）

event.stopPropagation() 停止事件向上层元素冒泡

在事件处理函数中，可以用this关键字，返回事件针对的DOM元素：

　　$(‘a’).click(function() {

if ($(this).attr(‘href’).match(‘evil’)) { //如果确认为有害链接

e.preventDefault(); //阻止打开

$(this).addClass(‘evil’); //加上表示有害的class

}

});

有两种方法，可以自动触发一个事件。一种是直接使用事件函数，另一种是使用.trigger()或.triggerHandler()。

　　$(‘a’).click();

$(‘a’).trigger(‘click’);

九、特殊效果

jQuery允许对象呈现某些特殊效果。

　　$(‘h1′).show(); //展现一个h1标题

常用的特殊效果如下：

　　.fadeIn() 淡入

.fadeOut() 淡出

.fadeTo() 调整透明度

.hide() 隐藏元素

.show() 显示元素

.slideDown() 向下展开

.slideUp() 向上卷起

.slideToggle() 依次展开或卷起某个元素

.toggle() 依次展示或隐藏某个元素

除了.show()和.hide()，所有其他特效的默认执行时间都是400ms（毫秒），但是你可以改变这个设置。

　　$(‘h1′).fadeIn(300); // 300毫秒内淡入

$(‘h1′).fadeOut(‘slow’); // 缓慢地淡出

在特效结束后，可以指定执行某个函数。

　　$(‘p’).fadeOut(300, function() { $(this).remove(); });

更复杂的特效，可以用.animate()自定义。

　　$(‘div’).animate(

{

left : “+=50″, //不断右移

opacity : 0.25 //指定透明度

},

300, // 持续时间

function() { alert(‘done!’); } //回调函数

);

.stop()和.delay()用来停止或延缓特效的执行。

$.fx.off如果设置为true，则关闭所有网页特效。

（完）

针对Python Style Guide Jun 18, 2009 版本翻译

• 译文发布于：http://www.elias.cn/Develop/PythonStyleGuide
• 译者：elias DOT soong AT gmail DOT com

本文是向 Melange 项目贡献 Python 代码的编码风格指南。

SoC framework项目以及在此之上构建的Melange web applications都是用 Python 语言实现的（因为 Python 是Google App Engine目前支持的唯一一种编程语言）。本编码风格指南是向 Melange 项目贡献 Python 代码的“要做”和“不要做”的列表。

下面这些规则不是原则或建议，而是严格的规定。你不能不理会这些规定除非是确实需要使用并被允许了，但仍然要注意本指南结尾处一致性部分的建议。

如果你有关于这些准则的问题，可以向开发者邮件列表发邮件询问。请在邮件标题写上“Python style:”，以便在邮件列表归档中更容易定位这些讨论。

本编码风格指南写在 Melange 项目的 Wiki 上，可以遵循已有的文档复查流程?进行修改。但不应该轻易修改本文，因为一致性是本指南的一个关键目标，而且不能因为新的风格指南变化而需要更新旧代码。

1.  概述

1.1  Python 语言方面的准则

1. pychecker: 建议使用
2. 导入模块和包: 可以，但不要 import *
3. 完整路径导入: 可以
4. 异常处理: 可以
5. 全局变量: 谨慎使用
6. 内嵌/本地/内部类和函数: 可以
7. List Comprehensions: 可以用，如果简明易懂的话
8. 默认迭代器和运算符: 可以
9. 生成器: 可以
10. 使用 apply、 filter、 map、 reduce: 对one-liner来说可以
11. Lambda 函数: 对one-liner来说可以
12. 默认参数值: 可以
13. Properties: 可以
14. True/False 求值: 可以
15. 布尔内置类型: 可以
16. String 方法: 可以
17. 静态域: 可以
18. 函数和方法修饰符: 适度使用
19. 线程: 不要用（Google App Engine不支持）
20. 高级特性: 不要用

1.2  Python 编码风格方面的准则

所有文件都保持一致风格时程序要容易维护得多，以下是 Melange 项目的标准 Python 编码风格规范：

1. 分号: 避免使用
2. 每行长度: 最多80列
3. 圆括号: 吝啬地用
4. 缩进: 2 空格（不要用 tab ），和PEP8有所区别
5. 空行: 对函数和类用 2 个空行分隔，对类的方法用 1 个空行
6. 空格: 在行内吝啬地使用
7. Python 解释器: 用Google App Engine支持的那个： #!/usr/bin/python2.5
8. 注释: __doc__strings、块注释、行内注释
   • __doc__ Strings
   • 模块
   • 函数和方法
   • 类
   • 块注释及行内注释
9. 类: 继承 object
10. 字符串: 避免重复使用 + 和 +=
11. TODO style: TODO(username): 使用一种一致的风格
12. import 分组、排序和整理: 一行一个，按包名字分组顺序放置，按字母顺序排序
13. 语句: 一行一个，避免使用分号
14. 访问控制: 轻量化风格可以用 foo，否则用 GetFoo() 和 SetFoo()
15. 命名: 用 foo_bar.py 而不是 foo-bar.py，和PEP8有些区别
16. 程序入口: if __name__ == ‘__main__’:
17. 总结: 看看你周围是什么

2.  Python 语言方面的准则

2.1  pychecker

是什么： pychecker 是从 Python 源代码中找 Bug 的工具。类似 lint ，它寻找在 C 和 C++ 那样更少动态化的语言中通常由编译器捕捉的那些问题。因为 Python 天生就是动态化的，其中一些警告可能并不正确；但假警报应该是相当少见的。

优点： 捕捉易犯的错误，比如拼写、在赋值之前就使用变量等等。

缺点： pychecker 不是完美的。为了好好利用它，我们有时候得：a) 针对它来写代码 b) 禁用特定警告 c) 改进它 d) 或者忽略它。

决定： 确保在代码上执行 pychecker。

你可以设置一个名为 __pychecker__ 的模块级别变量来适当禁用某些警告。比如：

用这种方法禁用有个好处：我们可以很容易地找到这些禁用并且重新启用它们。

你可以用 pychecker –help 来获得 pychecker 警告的列表。

禁用“未被使用的变量”警告可以用 _ 作为未使用变量的标识符，或者给变量名添加 unused_ 前缀。有些情况下无法改变变量名，那你可以在函数开头调用它们一下，比如：

最理想的是， pychecker 会竭尽全力保证这样的“未使用声明”是真实的。

你可以在PyChecker 主页找到更多相关信息。

2.2  导入模块和包

是什么： 在模块与模块之间共享代码的重用机制。

优点： 最简单同时也是最常用的共用方法。

缺点： from foo import * 或者 from foo import Bar 很恶心而且这会使寻找模块之间的依赖关系变难，从而导致严重的维护问题。

决定： 用 import x 来导入包和模块。只有在 x 是一个包（package），而 y 是一个模块（module）的时候才用 from x import y 。这可以让使用者无需说明完整的包前缀就能引用模块。比如 sound.effects.echo 包可以像下面这样导入：

即使模块是在同一个包里，也不要直接导入模块而不给出完整的包名字。这可能导致包被导入多次以及非预期的副作用。

例外的情况：当且仅当 Bar 是 foo 中的一个顶级 singleton，并且叫做 foo_Bar 是为了描述 Bar 与 foo 之间的关系，那么才可以用 from foo import Bar as foo_Bar 。

比如，像下面这样是可以的：

以下写法更受欢迎：

2.3  完整路径导入

是什么： 每个模块都通过模块的完整路径位置导入和引用。

优点： 避免模块名字之间的冲突，而且查找模块更容易。

缺点： 部署代码会麻烦一些，因为你必须重现整个包的分层结构。

决定： 所有新代码都应该使用他们的包名字来引用模块。不要为了从其他目录导入模块而修改 sys.path 和 PATHONPATH。（可能有些情况下仍然需要修改路径，但只要可能的话就应该避免这样做。）

应该像下面这样导入：

有些包名字可能和常用的本地变量名是一样的。在这种情况下为了避免混乱，先导入包然后清晰地单独导入模块有时候也是有意义的。结果看起来像这样：

这篇文档改编自Guido最初的《Python风格指南》一文，并从《Barry’s style guide》中添加了部分内容。在有冲突的地方，Guide的风格规则应该是符合本PEP的意图(译注：指当有冲突时，应以Guido风格为准)。这篇PEP仍然尚未完成(实际上，它可能永远都不会完成)。
在这篇风格指导中的一致性是重要的。在一个项目内的一致性更重要。在一个模块或函数内的一致性最重要。但最重要的是：知道何时会不一致——有时只是没有实施风格指导。当出现疑惑时，运用你的最佳判断，看看别的例子，然后决定怎样看起来更好。并且要不耻下问！
打破一条既定规则的两个好理由：
(1) 当应用这个规则是将导致代码可读性下降，即便对某人来说，他已经习惯于按这条规则来阅读代码了。
(2) 为了和周围的代码保持一致而打破规则(也许是历史原因)，虽然这也是个清除其它混乱的好机会(真正的XP风格)。

代码的布局
缩进
使用Emacs的Python-mode的默认值：4个空格一个缩进层次。对于确实古老的代码，你不希望产生混乱，可以继续使用8空格的制表符(8-space tabs)。Emacs Python-mode自动发现文件中主要的缩进层次，依此设定缩进参数。

制表符还是空格
永远不要混用制表符和空格。最流行的Python缩进方式是仅使用空格，其次是仅使用制表符，混合着制表符和空格缩进的代码将被转换成仅使用空格。(在Emacs中，选中整个缓冲区，按ESC-x去除制表符。)调用Python命令行解释器时使用-t选项，可对代码中不合法得混合制表符和空格发出警告，使用-tt时警告将变成错误。这些选项是被高度推荐的。
对于新的项目，强烈推荐仅使用空格而不是制表符。许多编辑器拥有使之易于实现的功能(在Emacs中，确认indent-tabs-mode是nil)。

行的最大长度
周围仍然有许多设备被限制在每行80字符：而且，窗口限制在80个字符。使将多个窗口并排放置成为可能。在这些设备上使用默认的折叠方式看起来有点丑陋。因此，请将所有行限制在最大79字符(Emacs准确得将行限制为长80字符)，对顺序排放的大块文本(文档字符串或注释)，推荐将长度限制在72字符。
折叠长行的首选方法是使用Pyhon支持的圆括号，方括号和花括号内的行延续。如果需要，你可以在表达式周围增加一对额外的圆括号，但是有时使用反斜杠看起来更好，确认恰当得缩进了延续的行。
Emacs的Python-mode正确得完成了这些。一些例子：
#!Python
class Rectangle(Blob)：
def __init__(self，width，height，color=’black’，emphasis=None，highlight=0)：
if width == 0 and height == 0 and \
color == ‘red’ and emphasis == ‘strong’ or \
highlight > 100：
raise ValueError， “sorry， you lose”
if width == 0 and height == 0 and (color == ‘red’ or
emphasis is None)：
raise ValueError，”I don’t think so”
Blob.__init__(self，width，height，color，emphasis，highlight)

空行
用两行空行分割顶层函数和类的定义，类内方法的定义用单个空行分割，额外的空行可被用于(保守的)分割相关函数组成的群，在一组相关的单句中间可以省略空行。(例如：一组哑元素)。
当空行用于分割方法的定义时，在‘class’行和第一个方法定义之间也要有一个空行。在函数中使用空行时，请谨慎的用于表示一个逻辑段落。Python接受contol-L(即^L)换页符作为空格：Emacs(和一些打印工具)，视这个字符为页面分割符，因此在你的文件中，可以用他们来为相关片段分页。

编码
Python核心发布中的代码必须始终使用ASCII或Latin-1编码(又名 ISO-8859-1)，使用ASCII的文件不必有编码cookie，Latin-1仅当注释或文档字符串涉及作者名字需要Latin-1时才被使用：
另外使用\x转义字符是在字符串中包含非ASCII(non-ASCII)数据的首选方法。
作为PEP 263实现代码的测试套件的部分文件是个例外。

导入
通常应该在单独的行中导入(Imports)，例如：
No：import sys， os
Yes：import sys
import os
但是这样也是可以的：
from types import StringType， ListType
Imports 通常被放置在文件的顶部，仅在模块注释和文档字符串之后，在模块的全局变量和常量之前。Imports应该有顺序地成组安放：
1、标准库的导入(Imports )
2、相关的主包(major package)的导入(即，所有的email包在随后导入)
3、特定应用的导入(imports)
你应该在每组导入之间放置一个空行，对于内部包的导入是不推荐使用相对导入的，对所有导入都要使用包的绝对路径。
从一个包含类的模块中导入类时，通常可以写成这样：
from MyClass import MyClass
from foo.bar.YourClass import YourClass
如果这样写导致了本地名字冲突，那么就这样写
import MyClass
import foo.bar.YourClass
即使用”MyClass.MyClass”和”foo.bar.YourClass.YourClass”

表达式和语句中的空格
Guido不喜欢在以下地方出现空格：
紧挨着圆括号，方括号和花括号的，如：”spam( ham[ 1 ]，{ eggs：2 } )”。要始终将它写成”spam(ham[1]，{eggs： 2})”。
紧贴在逗号，分号或冒号前的，如：
“if x == 4：print x，y：x，y = y，x”。要始终将它写成
“if x == 4：print x，y：x，y = y，x”。
紧贴着函数调用的参数列表前开式括号(open parenthesis )的，如”spam (1)”。要始终将它写成”spam(1)”。
紧贴在索引或切片，开始的开式括号前的，如：
“dict ['key'] = list [index]“。要始终将它写成”dict['key'] = list[index]“。
在赋值(或其它)运算符周围的用于和其它并排的一个以上的空格，如：
#!Python
x= 1
y= 2
long_variable = 3
要始终将它写成
#!Python
x = 1
y = 2
long_variable = 3
(不要对以上任意一条和他争论——Guido 养成这样的风格超过20年了。)

其它建议
始终在这些二元运算符两边放置一个空格：赋值(=)， 比较(==，，!=，<>，=，in，not in，is，is not)，布尔运算 (and，or，not)。
按你的看法在算术运算符周围插入空格。 始终保持二元运算符两边空格的一致。
一些例子：
#!Python
i = i+1
submitted = submitted + 1
x = x*2 – 1
hypot2 = x*x + y*y
c = (a+b) * (a-b)
c = (a + b) * (a – b)
不要在用于指定关键字参数或默认参数值的’='号周围使用空格，例如：
#!Python
def complex(real， imag=0。0)：
return magic(r=real， i=imag)
不要将多条语句写在同一行上：
No： if foo == ‘blah’：do_blah_thing()
Yes：if foo == ‘blah’：
do_blah_thing()

No：do_one()：do_two()：do_three()
Yes： do_one()
do_two()
do_three()

注释
同代码不一致的注释比没注释更差。当代码修改时，始终优先更新注释!注释应该是完整的句子，如果注释是一个短语或句子，首字母应该大写，除非他是一个以小写字母开头的标识符(永远不要修改标识符的大小写)。
如果注释很短，最好省略末尾的句号。注释块通常由一个或多个由完整句子构成的段落组成，每个句子应该以句号结尾。你应该在句末，句号后使用两个空格，以便使Emacs的断行和填充工作协调一致。
用英语书写时，断词和空格是可用的。非英语国家的Python程序员：请用英语书写你的注释，除非你120%的确信这些代码不会被不懂你的语言的人阅读。

注释块
注释块通常应用于跟随着一些(或者全部)代码并和这些代码有着相同的缩进层次。注释块中每行以‘#’和一个空格开始(除非他是注释内的缩进文本)。注释块内的段落以仅含单个‘#’的行分割。注释块上下方最好有一空行包围(或上方两行下方一行，对一个新函数定义段的注释)。

行内注释
一个行内注释是和语句在同一行的注释，行内注释应该谨慎适用，行内注释应该至少用两个空格和语句分开，它们应该以’#'和单个空格开始。
x = x+1 # Increment x
如果语意是很明了的，那么行内注释是不必要的，事实上是应该被移除的。不要这样写：
x = x+1 # Increment x
x = x+1 # Compensate for border
但是有时，这样是有益的：
x = x+1 # Compensate for border

文档字符串
应该一直遵守编写好的文档字符串的约定PEP 257 [3]。为所有公共模块，函数，类和方法编写文档字符串。文档字符串对非公开的方法不是必要的，但你应该有一个描述这个方法做什么的注释。这个注释应该在”def”这行后。
PEP 257 描述了好的文档字符串的约定。一定注意，多行文档字符串结尾的”"”应该单独成行，例如：
“”"Return a foobang
Optional plotz says to frobnicate the bizbaz first。
“”"
对单行的文档字符串，结尾的”"”在同一行也可以。
版本注记
如果你要将RCS或CVS的杂项(crud)包含在你的源文件中，按如下做。
#!Python
__version__ = “$Revision： 1。4 $”
# $Source： E：/cvsroot/Python_doc/pep8。txt，v $
这个行应该包含在模块的文档字符串之后，所有代码之前，上下用一个空行分割。

命名约定
Python库的命名约定有点混乱，所以我们将永远不能使之变得完全一致，不过还是有公认的命名规范的。新的模块和包(包括第三方的框架)必须符合这些标准，但对已有的库存在不同风格的，保持内部的一致性是首选的。

描述：命名风格
有许多不同的命名风格。以下的有助于辨认正在使用的命名风格，独立于它们的作用。 以下的命名风格是众所周知的：
b (单个小写字母)
B (单个大写字母)
Lowercase（小写）
lower_case_with_underscores（有下划线的小写）
UPPERCASE（大写）
UPPER_CASE_WITH_UNDERSCORES（有下划线的大写）
CapitalizedWords (或 CapWords，CamelCase这样命名是因为可从字母的大小写分出单词。这有时也被当作StudlyCaps。
mixedCase (与CapitalizedWords的不同在于首字母小写!)
Capitalized_Words_With_Underscores（有下划线的首字母大写） (丑陋!)
还有用短的特别前缀将相关的名字聚合在一起的风格。这在Python中不常用，但是出于完整性要提一下，例如，os.stat()函数返回一个元组，他的元素传统上说名如st_mode， st_size，st_mtime等等。
X11库的所有公开函数以X开头。(在Python中，这个风格通常认为是不必要的，因为属性和方法名以对象作前缀，而函数名以模块名作前缀。)
另外，以下用下划线作前导或结尾的特殊形式是被公认的(这些通常可以和任何习惯组合)：
_single_leading_underscore(单个下划线作前导)：弱的“内部使用(internal use)”标志。 (例如，“from M import *”不会导入以下划线开头的对象)。
single_trailing_underscore_(单个下划线结尾)： 用于避免与Python关键词的冲突，例如：“Tkinter.Toplevel(master，class_=’ClassName’)”。
_double_leading_underscore(双下划线)：从Python 1.4起为类私有名。
_double_leading_and_trailing_underscore_：“magic”对象或属性，存在于用户控制的(user-controlled)名字空间，例如：_init_， _import_ 或_file_。有时它们被用户定义用于触发某个魔法行为(例如：运算符重载)：有时被构造器插入，以便自己使用或为了调试。因此，在未来的版本中，构造器(松散得定义为Python解释器和标准库)可能打算建立自己的魔法属性列表，用户代码通常应该限制将这种约定作为己用。欲成为构造器的一部分的用户代码可以在下滑线中结合使用短前缀，例如：
_bobo_magic_attr__。

说明：命名约定
应避免的名字。永远不要用字符‘l’(小写字母el(就是读音，下同))，‘O’(大写字母oh)，或‘I’(大写字母eye)作为单字符的变量名。在某些字体中这些字符不能与数字1和0分辨。试着在使用‘l’时用‘L’代替。

模块名
模块应该是不含下划线的，简短的，小写的名字。因为模块名被映射到文件名，有些文件系统大小写不敏感并且截短长名字，模块名被选为相当短是重要的，这在Unix上不是问题，但当代码传到Mac或Windows上就可能是个问题了。
当用C或C++编写的扩展模块有一个伴随Python模块提供高层(例如进一步的面向对象)接口时，C/C++模块有下划线前导(如：_socket)。Python包应该是不含下划线的，简短的，全小写的名字。

类名
几乎不出意料，类名使用CapWords约定。内部使用的类外加一个前导下划线。

异常名
如果模块对所有情况定义了单个异常，它通常被叫做“error”或“Error”。似乎内建(扩展)的模块使用“error”(例如：os.error)，而Python模块通常用“Error” (例如：xdrlib.Error)。趋势似乎是倾向使用CapWords异常名。

全局变量名
(让我们祈祷这些变量仅在一个模块的内部有意义)
这些约定和在函数中的一样。模块是被设计为通过“from M import *”来使用的，必须用一个下划线作全局变量(及内部函数和类)的前缀防止其被导出(exporting)。

函数名
函数名应该为小写，可能用下划线风格单词以增加可读性。mixedCase仅被允许用于这种风格已经占优势的上下文(如：threading.py)，以便保持向后兼容。

方法名和实例变量
这段大体上和函数相同：通常使用小写单词，必要时用下划线分隔增加可读性。仅为不打算作为类的公共界面的内部方法和实例使用一个前导下划线，Python不强制要求这样：它取决于程序员是否遵守这个约定。
使用两个前导下划线以表示类私有的名字，Python将这些名字和类名连接在一起：
如果类Foo有一个属性名为_a，它不能以Foo._a访问。(固执的用户还是可以通过Foo._Foo__a得到访问权。)
通常双前导下划线仅被用于避免含子类的类中的属性名的名字冲突。

继承的设计
始终要确定一个类中的方法和实例变量是否要被公开。通常，永远不要将数据变量公开，除非你实现的本质上只是记录，人们几乎总是更喜欢代之给出一个函数作为类的界面(Python 2.2 的一些开发者在这点上做得非常漂亮)。
同样，确定你的属性是否应为私有的。私有和非私有的区别在于模板将永远不会对原有的类(导出类)有效，而后者可以。你应该在大脑中就用继承设计好了你的类，私有属性必须有两个前导下划线，无后置下划线，非公有属性必须有一个前导下划线，无后置下划线，公共属性没有前导和后置下划线，除非它们与保留字冲突，在此情况下，单个后置下划线比前置或混乱的拼写要好，例如：class_优于klass。
最后一点有些争议：如果相比class_你更喜欢klass，那么这只是一致性问题。

设计建议
单个元素(singletons)的比较，如None 应该永远用：‘is’或‘is not’来做。当你本意是“if x is not None”时，对写成“if x”要小心。例如当你测试一个默认为None的变量或参数是否被设置为其它值时，这个值也许在布尔上下文(Boolean context)中是false！
基于类的异常总是好过基于字符串的异常。模块和包应该定义它们自己的域内特定的基异常类，基类应该是内建的Exception类的子类。还始终包含一个类的文档字符串。例如：
#!Python
class MessageError(Exception)：
“”"Base class for errors in the email package。”"”
使用字符串方法(methods)代替字符串模块，除非必须向后兼容Python 2.0以前的版本。字符串方法总是非常快，而且和unicode字符串共用同样的API(应用程序接口)在检查前缀或后缀时避免对字符串进行切片。用startswith()和endswith()代替，因为它们是明确的并且错误更少。例如：
No： if foo[：3] == ‘bar’：
Yes： if foo。startswith(‘bar’)：
例外是如果你的代码必须工作在Python 1.5.2 (但是我们希望它不会发生！)，对象类型的比较应该始终用isinstance()代替直接比较类型，例如：
No： if type(obj) is type(1)：
Yes： if isinstance(obj， int)：
检查一个对象是否是字符串时，紧记它也可能是unicode字符串！在Python 2.3，str和unicode有公共的基类，basestring，所以你可以这样做：
if isinstance(obj， basestring)：
在Python 2.2类型模块为此定义了StringTypes类型，例如：
#!Python
from types import StringTypes
if isinstance(obj， StringTypes)：
在Python 2.0和2.1，你应该这样做：
#!Python
from types import StringType， UnicodeType
if isinstance(obj， StringType) or \
isinstance(obj， UnicodeType) ：
对序列，(字符串，列表，元组)，使用空列表是false这个事实，因此“if not seq”或“if seq”比“if len(seq)”或“if not len(seq)”好。书写字符串文字时不要依赖于有意义的后置空格。这种后置空格在视觉上是不可辨别的，并且有些编辑器(特别是近来，reindent.py)会将它们修整掉。不要用==来比较布尔型的值以确定是True或False(布尔型是Pythn 2.3中新增的)
No： if greeting == True：
Yes： if greeting：

No： if greeting == True：
Yes： if greeting：