Форум Сообщества Аналитиков

Общий раздел => Примеры => Тема начата: m2broth от 16 Декабря 2010, 12:59:33

Название: исходный код модуля
Отправлено: m2broth от 16 Декабря 2010, 12:59:33

срочно нужны примеры описания исходного кода модуля для технической документации. Или подскажите какие диаграммы лучше использовать и по какому принципу описывать

Название: Re: исходный код модуля
Отправлено: Thyestes от 16 Декабря 2010, 13:11:54

Прошу прощения, а Вы сами поняли что спросили?

Могли бы и Википедию почитать.

Исхо́дный код (также исхо́дный текст) — компьютерная программа в текстовом виде на каком-либо языке программирования. В обобщенном смысле — любые входные данные для транслятора.

Исходный код либо используется для получения объектного кода, либо выполняется интерпретатором. Изменения никогда не выполняются над объектным кодом, только над исходным, с последующим повторным преобразованием в объектный.

Другое важное назначение исходного кода — в качестве описания программы. По тексту программы можно восстановить логику её поведения. Для облегчения понимания исходного кода используются комментарии. Существуют также инструментальные средства, позволяющие автоматически получать документацию по исходному коду — т. н. генераторы документации - ссылка на статью, там внизу есть список программ -
http://ru.wikipedia.org/wiki/%D0%93%D0%B5%D0%BD%D0%B5%D1%80%D0%B0%D1%82%D0%BE%D1%80_%D0%B4%D0%BE%D0%BA%D1%83%D0%BC%D0%B5%D0%BD%D1%82%D0%B0%D1%86%D0%B8%D0%B8 (http://ru.wikipedia.org/wiki/%D0%93%D0%B5%D0%BD%D0%B5%D1%80%D0%B0%D1%82%D0%BE%D1%80_%D0%B4%D0%BE%D0%BA%D1%83%D0%BC%D0%B5%D0%BD%D1%82%D0%B0%D1%86%D0%B8%D0%B8)

Название: Re: исходный код модуля
Отправлено: m2broth от 16 Декабря 2010, 13:21:48

мне просто нужно выполнить задание "описание исходного кода модулей", не могу определиться как это сделать. Не думаю что нужно добавить комментарии к исходному коду

Название: Re: исходный код модуля
Отправлено: ida - брэнд с 14-летней историей от 16 Декабря 2010, 13:52:47

Цитата: m2broth от 16 Декабря 2010, 13:21:48

мне просто нужно выполнить задание "описание исходного кода модулей", не могу определиться как это сделать.

Мы тоже не можем. По такой постановке.
Требуйте детализацию или примеры.

Название: Re: исходный код модуля
Отправлено: Thyestes от 16 Декабря 2010, 14:32:18

К примеру посмотри статью http://lib.rus.ec/b/170033/read#t7 (http://lib.rus.ec/b/170033/read#t7)

Там есть пример:

Цитировать

Полный код модуля программы Работа с файлами представлен в листинге 2.1.

Листинг 2.1. Модуль программы Работа с файлами

unit Unit1;
interface
uses
 Windows, Messages, SysUtils, Variants, Classes, Graphics, Controls, Forms, Dialogs, StdCtrls, ShellAPI, Gauges;
type TForm1 = class(TForm)
 from: TEdit;
 where: TEdit;
 Button1: TButton;
 Label1: TLabel;
 Label2: TLabel;
 Label3: TLabel;
 Label4: TLabel;
 Button2: TButton;
 Button3: TButton;
 Open1: TOpenDialog;
 Save1: TSaveDialog;
 Button4: TButton;
 del: TEdit;
 Button5: TButton; ...

Может поможет.