Большой Воронежский Форум
» Программирование>Нужна помощь по описанию кода.
Dr_virus2 14:17 12.12.2009
Ребят, такая ерунда, есть программа, нужно в курсовой сделать описание ее програмного кода, подскажите как это сделать, желательно с примерами, зарание спсибо. [Ответ]
Yandex 14:37 12.12.2009
Dr_virus2, как-как. Берешь и пишешь. Ручками.

Пример
[php]
// Я функция
// Я всегда вру
// Я не знаю зачем меня написали
function ya_funcya
{
return false;
}
[/php] [Ответ]
MadFish 15:08 12.12.2009
UML не пойдет? [Ответ]
Dr_virus2 15:08 12.12.2009
просто в программировании я полный ноль, вот пример из моей программы:
program sambulov;
var i,j,n : byte; //n-размерность матрицы
matrix: array [byte,byte] of integer;
str: string;
//------------------------------------------------------------------
//функция по нахождению максимального элемента в массиве
function MaxElement(var arr:array[byte] of integer; sz : integer) : integer;
var i: integer;
begin
Result:=arr[1];
for i:=1 to sz do
if arr[i]>Result then Result:=arr[i];
end;
можно еще раз на этом примере, плизз?? [Ответ]
Yandex 15:19 12.12.2009
MadFish, для курсача UML? Круто то как то.
В России так уж повелось, что наличие хоть какой то документации уже чудо, даже если она и не в каком либо стандарте документирования.

Данный код можно переписать, что он станет самодокументированным.
И соответсвенно документация по нему будет название фунции + описание, что она делает в виде: получает максимальный элемент в входящем массиве.
P.S. Сильно изголяться с названиями не стал, но можно лучше подобрать.
[php]
function getMaxArrayElement (var input_array: array[byte] of integer; PosTo: integer): integer;
var
PosNo: integer;
CurrMaxValue: Byte;
begin
CurrMaxValue := input_array [1];

for PosNo := 1 to PosTo do
if input_array [PosNo] > CurrMaxValue then
CurrMaxValue := input_array [PosNo];
end;

Result := CurrMaxValue;
end;
[/php] [Ответ]
Dr_virus2 15:25 12.12.2009
Так мне нужно описание этого кода, а я не понимаю, как это сделать, программу конечно писал не я, но описание мне писать нужно, это как нужно каждую функцию описывать, какждый оператор или как и в виде комментариев рядом или что, ничерта не знаю(((( [Ответ]
Yandex 15:30 12.12.2009
Dr_virus2, то что у тебя есть придется описывать блоками + описание у каждой функции.
Если бы код был по человечьи написан, то достаточно было бы короткого каммента вначале функции.

А вообще прочитал бы книжку по Delphi (первые страниц 30-60) и сам бы все написал. Лентяй. [Ответ]
Вверх