Introduction to JavaScript library development rules

[Introduction] 1 Keep it non-intrusive My HTML tags don’t want to know about your JavaScript code. 2 It is strictly prohibited to modify and extend the Object prototype! This is very important, so a rule is needed that is completely targeted at it. Objects are the basic building blocks of JavaScript functionality, don't mess with them. 3 No

1. Keep it non-intrusive My HTML markup doesn't want to know about your JavaScript code.

2. Modification and extension of Object.prototype is strictly prohibited! This is very important, so a rule is required that is completely targeted at it. Objects are the basic building blocks of JavaScript functionality, don't mess with them.

3. Don’t over-extend the fewer extensions to JavaScript’s built-in objects, the better. Don't get me wrong. There are a bit few useful methods in JavaScript's native objects, and sometimes you have to add one or two of your own. However, for creative (library) programmers, adding these "one or two" methods is not enough. However, please stop! Just add what you need. The fewer extensions you have to JavaScript's built-in objects, the less likely your code will conflict with other frameworks.

4. Follow standards As a library developer, you define patterns for JavaScript code. Design patterns are a reflection of weak programming language skills. Remember, JavaScript and the DOM are still being standardized. If you want to "fix" something, it's best to see if it's already been fixed and consider existing solutions. If you follow the standard, follow the standard closely (for example: don't leave out a parameter in the forEach method).

5. Or follow the lead Mozilla leads JavaScript. Brendan Eich, the creator of the JavaScript language, is still developing. These new language features are available first in Mozilla than in other browsers. If you want to add new language features to JavaScript, you can start by taking a look at the Mozilla standards. For example, when you want to extend an enumeration method to an Array object, it is best to name this method forEach instead of each. If you really want to provide language features that do not yet exist, then please closely follow the existing standards. (Refer to the example above).

6. Be flexible. Is it easy if I want to modify the behavior without changing your source code? If it's not easy enough, make it easier.

7. Manage memory Everyone is worried about memory leaks, so you have to do your best.

8. Eliminate browser sniffing It seems that browser vendors will always compete by adding new features ;-) As a library developer, you need to keep up with the latest trends. It's not enough to browse Ajaxian once in a while, you have to slavishly read every blog post to find the next hack. Browser sniffing can be addictive.

9. Smaller and better Various JavaScript libraries have matured. Some libraries are already used on mainstream websites. But not everyone has 2MBit of DSL bandwidth installed, so keep your library small. Better yet, provide a packaging page that allows me to efficiently build my own library to my needs.

10. Good ol’ tenth rule (It seems to be a colloquial usage, I don’t know how to translate it well). You can always rely on the tenth rule. Here it is: Stay predictable. I should be able to guess what your method is used for. If I don't know the name of a method, I should be able to guess it.

11. Additional rules
Documentation, annoying but absolutely necessary.
The more namespaces you use, the harder it is for me to remember, just like your phone number.
Remember: potentially millions of people will execute your code.

The above is the detailed content of Introduction to JavaScript library development rules. For more information, please follow other related articles on the PHP Chinese website!