Programming - Design source: the basic requirements for listing of the program focused on the general public.

<b>Programming</b> - Design source: the basic requirements for listing of the program focused on the general public.

(C) Dr.Lion / RSM


  From time to time I get into the hands of other sources of 
programmers cake. The main problem is that the readability and 
design of these sources does not lend itself to criticism. Yes, 
with a special desire and a clever mind can understand foreign 
labor, or at least find interesting our area code and paste it 
into your creation without any optimization.


  If you, dear coder expose
the source code of their programs to the public
Review, do not forget that they will be
Read other people who are often
difficult to understand what's happening in your brilliant 
mind. Make out the source code in a beautiful, full of relevant 
comments and disclosures in the form. Here are the main 
requirements which, in my opinion, should match listing for the 
program, aimed at the general public: 

1.Funktsionalnaya completeness of the code. If

  some kind of code performs a strictly defined
  nuyu scale function (s), its

  better in a separate loadable

  source (ca. player AY music program
  MMA work with an arrow block arithmetic
  analytic functions, etc.)

2.Ves text of source code must be Draw
  flax in the same type of style, ie All susceptibility
  understood as a single text.

3.Kazhduyu functionally complete subspace
  gram should be called a name that

  most displays are the work under
  program. The first line of subroutine

  should be a line-comment, showing
  yuschaya full name of the subroutine or

  describes the routine performed by

  function. Label names inside a subroutine

  should indicate a clear affiliation

  the subprogramme.

4.Kazhdy piece of code routines, the Executive
  preserves its particular subfunction desirable

  provide explanatory commentary. But

  do not have to paint each

  command code.

5.Lyuboy assembler allows the use of

  source file are three types of commands:

  a) a complete set of programs broadcast in code com
     Mand Z80;

  b) conventional command helper

     (Eg, ORG, DEFB, DEFW, DEFS, EQU);

  a) specific commands assembler

     (Eg for ALASM command DISP, ENT,

     DUP, EDUP, MACRO, etc.).

  In order that-be could be the source le
  SCG convert any assembler it

  must contain a minimum number of

  commands from the group.

6.B beginning, it is desirable to indicate the author
  torstvo, the date of the last edition, the type of

  sources (independent or dependent

  other source), a complete list of wasps
  novnyh routines of this source.

7.Vse tags desirable to write with the use of
  vaniem lowercase popimo capital.

  Thus a variety of labels and aesthetic
  cally form, you are guaranteed.

8.Mozhet something else already and I do not remember.


  An example of a human being drawn up the source code may 
serve any of my source from the application log.