Shulou(Shulou.com)06/02 Report--

This article mainly explains "what are the coding rules of P5EE". The content of the explanation is simple and clear, and it is easy to learn and understand. Please follow the editor's train of thought to study and learn what the coding rules of P5EE are.

Perl version

We write all the code on perl5.005_03. Maybe one day we should take advantage of the following features of perl5.6. In any case, all code should work on perl5.005_03 and subsequent versions. All of P5EE's core code has been tested on perl5.005_03 and perl5.6.0, although P5EE is now more commonly used on perl5.6.

Document

All module documentation should be written with reference to the POD examples in the module template file, explaining the method, purpose, and purpose of the module, and each common API with name, description, input, output, affected factors, and other information. In the document, if you need to return a reference to an array or hash table, record the size of the array (including an appropriate description of what each element is) and the name of each key in the hash table. If it is a composite data structure, try to describe the appropriate structure. In addition, record the type of value of the returned data in the document. Is it an integer, a piece of HTML code, or a Boolean value? The options for all command-line programs are recorded using the code in the command-line program sample file. Every effective method, switch structure, etc., is recorded, along with a description of the method, purpose, and how the program is used. Do not try to use the same options for programs for different purposes. For all WEB programs, the function, purpose, and use should be described in the program comments section. Any external documents, command line programs, and module documents should be written in POD style. In this way, we can convert them into other documents in various formats through a variety of pod2xxx converters. POD is not a formal markup language, it's just a way to make documents very easy to convert to other formats.

What versions of P5EE are available?

Use the code version of the module, the web program, and the command line program sample file respectively. The $VERSION in the module will reflect the version of CVS. The Makefile.PL file should contain a version description and should not depend on the version of any individual file in the CVS repository. Similarly, the XS module with $VERSION will reflect the release version, otherwise every time you make a change to the file, you need to recompile the libraries that are already shared. This is indeed a pain for people engaged in development work. Our distribution number uses tuples mode, with the first number being the major subscription number, the second number being the version number, and the third number being the subversion number. The Odd-numbered version number is the development version.

Thank you for your reading, these are the contents of "what are the coding rules of P5EE". After the study of this article, I believe you have a deeper understanding of what the coding rules of P5EE have, and the specific use needs to be verified in practice. Here is, the editor will push for you more related knowledge points of the article, welcome to follow!

Welcome to subscribe "Shulou Technology Information " to get latest news, interesting things and hot topics in the IT industry, and controls the hottest and latest Internet news, technology news and IT industry trends.