ТЕКСТ ПРОГРАММЫ (ГОСТ 19.401-78)

Требования к оформлению текста программы достаточно просты и естественны для грамотного программиста. Основное, чем требуется руководствоваться при создании этого документа – это то, что текст программы должен быть удобочитаемым.

По-прежнему обязательным является составление информационной части - аннотации и содержания.

Основная часть документа должна состоять из текстов одного или нескольких разделов, которым даны наименования.

Текст каждого программного файла начинается с "шапки", в которой указывается:

· наименование программы,

· автор,

· дата создания программы,

· номер версии,

· дата последней модификации.

Обязательными являются комментарии, а также строгое соблюдение правил отступа. Помните, оправдать можно даже неумение создавать программную документацию. А некрасивый текст программы – никогда. Ссылки на то, что этот текст понятен самому автору, всерьез не воспринимаются. Тексты программ должно быть не стыдно давать читать другим людям.

Ниже приведен пример подобного хорошо читаемого текста программы (взят с сайта Николая Гехта, e-mail:geht@omskreg.ru, http://users.omskreg.ru/~geht)

/* Исходные тексты Windows'98

Автор: Nobody Really

Source Code to Windows 98

*/

#include "win31.h"

#include "win95.h"

#include "evenmore.h"

#include "oldstuff.h"

#include "billrulz.h"

#include "monopoly.h"

#define INSTALL = HARD

char make_prog_look_big[1600000];

void main()

{

while(!CRASHED)

{

display_copyright_message();

display_bill_rules_message();

do_nothing_loop();

if(first_time_installation)

{

make_50_megabyte_swapfile();

do_nothing_loop();

totally_screw_up_HPFS_file_system();

search_and_destroy_the_rest_of_OS/2();

disable_Netscape();

disable_RealPlayer();

disable_Corel_Products();

hang_system();

}

write_something(anything);

display_copyright_message();

do_nothing_loop();

do_some_stuff();

if (still_not_crashed)

{

display_copyright_message();

do_nothing_loop();

basically_run_windows_3.1();

do_nothing_loop();

do_nothing_loop();

}

}

if (detect_cache())

disable_cache();

if (fast_cpu())

{

set_wait_states(lots);

set_mouse(speed, very_slow);

set_mouse(action, jumpy);

set_mouse(reaction, sometimes);

}

/* printf("Welcome to Windows 3.11"); */

/* printf("Welcome to Windows 95"); */

printf("Welcome to Windows 98");

if (system_ok())

crash(to_dos_prompt)

else

system_memory = open("a:\swp0001.swp", O_CREATE);

while(something)

{

sleep(5);

get_user_input();

sleep(5);

act_on_user_input();

sleep(5);

}

create_general_protection_fault();

}