Главная Случайная страница


Полезное:

Как сделать разговор полезным и приятным Как сделать объемную звезду своими руками Как сделать то, что делать не хочется? Как сделать погремушку Как сделать так чтобы женщины сами знакомились с вами Как сделать идею коммерческой Как сделать хорошую растяжку ног? Как сделать наш разум здоровым? Как сделать, чтобы люди обманывали меньше Вопрос 4. Как сделать так, чтобы вас уважали и ценили? Как сделать лучше себе и другим людям Как сделать свидание интересным?


Категории:

АрхитектураАстрономияБиологияГеографияГеологияИнформатикаИскусствоИсторияКулинарияКультураМаркетингМатематикаМедицинаМенеджментОхрана трудаПравоПроизводствоПсихологияРелигияСоциологияСпортТехникаФизикаФилософияХимияЭкологияЭкономикаЭлектроника






Документирование кода. Автоматизация документирования





 

Руководство пользователя

 

Типичное руководство пользователя содержит:

● Аннотацию, в которой приводится краткое изложение содержимого документа и его назначение

● Введение, содержащее ссылки на связанные документы и информацию о том, как лучше всего использовать данное руководство

● Страницу содержания

● Главы, описывающие, как использовать, по крайней мере, наиболее важные функции системы

● Глава, описывающая возможные проблемы и пути их решения

● Часто задаваемые вопросы и ответы на них

● Где ещё найти информацию по предмету, контактная информация

● Глоссарий и, в больших документах, предметный указатель.

Общая структура руководства пользователя приведена в следующей таблице, а титульный лис – на рис. 11.

 
 

 

 

 
 

Рис. 11

 

Содержание Руководства пользователя

• Титульная страница

• Предисловие

• Содержание

• Введение

• Требования к системе

• Подготовка к запуску

• Знакомство с системой

• Основные бизнес-процессы

• Печать документов

• Экспорт / Импорт данных

• Системные сообщения

• Справочники

• Глоссарий

• Предметный указатель

· Форма сообщения об ошибке, отзыве.

 

 


Руководство администратора включает в себя слуедующие разделы.

 

• Титульная страница

• Предисловие

• Содержание

• Введение

• Требования к системе

• Автоматическая установка системы

• Ручная установка системы

• Подготовка к запуску

• Знакомство с системой ADMIN GUIDE

• Конфигурирование системы

• Разграничение прав доступа к системе

• Обслуживание системы / регламентные работы / аудит

• Архивирование системы

• Восстановление после сбоев

• Системные сообщения

• Экспорт / импорт данных

• Справочники

• Глоссарий

• Предметный указатель

• Форма для сообщения об ошибке, отзыве

 

Документирование кода предполагает использование следующих составляющих.

1. Схем алгоритмов

2. Псевдокода

3. Самодокументирования

 

Самодокументирование – это комментарии в тексте программы.

 

Стандартизация и самодокументирование кода имеет следующие положительные моменты:

● Программисты могут прочитать код и легко в нем разобраться;

● Новые программисты быстрее вписываются в проект;

● Новые люди избавлены от необходимости разрабатывать свой стиль и отстаивать его;

● Позволяет избегать типичных ошибок «новичков».

Отрицательные моменты:

● Стандарты – никому не нужный мусор;

● Стандарт – это не то, что я хочу;

● Стандарты понижают творчество;

● Все равно люди не следуют стандартам.

 

Верификация кода

 

Под верифика́цией (от лат. verus — «истинный» и facere — «делать») могут подразумеваться разные понятия, например:

· проверка, проверяемость, способ подтверждения с помощью доказательств каких-либо теоретических положений, алгоритмов, программ и процедур путём их сопоставления с опытными (эталонными или эмпирическими) данными, алгоритмами и программами;

· подтверждение соответствия конечного продукта предопределённым эталонным требованиям

Мы будем ориентироваться на первое определение.

Методики и мероприятия верификации программного кода:

● статический анализ;

● метрики.

Статический анализ – это изучение предоставленных исходных кодов программных модулей. Он является формой инспектирования кодаю Это - технология обнаружения тех ошибок, которые могут быть пропущены другими технологиями (например, тестированием). К методам статического анализа кода относятся: анализ указателей, устранение мертвого кода, минимизация количества переменных, обнаружение типичных ошибок.

 


 

Инструменты анализа

 

Класс инструментов, предназначенный для вычисления метрик программного обеспечения, называют Software Estimation. Наиболее рапсространенными пакетами являются следующие.

«Locmetrics» – очень простой бесплатный продукт с минималистским интерфейсом. В числе поддерживаемых языков – C/C++, C#, Java, SQL – возможно вычисление не только метрики SLOC и ее разновидностей, но и цикломатической сложности.

«USC Codecount» – бесплатный продукт с открытыми исходными кодами на языке ANSI C, разработанный Университетом Южной Калифорнии (University of Southern California, USC) – той же организацией, в которой были созданы COCOMO/COCOMO II. Является официальным инструментом для подсчета метрики SLOC при использовании указанных моделей. В число поддерживаемых языков входят C/C++, C#, Java, JavaScript, SQL, Perl, XML. Методика расчета соответствует принятой SEI для моделей CMM/CMMI. Вычисляет количество логических и физических SLOC, пустых строк, комментариев, директив компилятора, описаний данных, исполняемых инструкций по файлам проекта по отдельности и суммарно.

«Code Counter Pro» – коммерческий продукт ($25 за одну лицензию). В отличие от предыдущих имеет развитый графический интерфейс. Поддерживаются следующие языки программирования: Java, JSP, C/C++, VB, PHP, HTML, Delphi/Pascal, ASM, XML, COBOL. Несмотря на то, что программа хорошо справляется со своей задачей и даже позволяет строить детальные отчеты, чего не может предложить, скажем, Locmetrics, она уступает рассмотренным открытым аналогам по количеству вычисляемых показателей (только число физических строк кода, комментариев, пустых строк, а также суммарные значения).

«Verisoft Complexity Measures Tool» – коммерческий продукт (1200 евро). Поддерживаются только языки C/C++ и Java. Рассчитывает следующие метрики: SLOC, цикломатическую сложность, метрики Холстеда, индекс сопровождаемости (вычисляется на основе предыдущих). Имеет графический интерфейс (с возможностью работы в режиме командной строки), позволяет формировать отчеты в текстовой форме или HTML.

«Eclipse Metrics Plugin» – представляет собой подключаемый модуль для популярной IDE Eclipse. Eclipse – свободно распространяемая среда программирования для языка Java, разработанная компанией IBM. Вычисляет SLOC, количественные метрики классов, цикломатическую сложность, метрики сложности классов (LOCOM1, LOCOM2, LOCOM3, WMPC, NORM, индекс специализации), метрики связности, уровень абстракции и некоторые другие. Достаточно функциональный продукт, который вполне может дать фору многим коммерческим аналогам.

Из рассматриваемых инструментов наиболее универсальным средством является «SLOCCount» – бесплатный продукт, разработанный Дэвидом Вилером (David A. Wheeler), поставляется в виде исходных кодов на языке C по лицензии GNU GPL. В число поддерживаемых языков входят Ada, Assembler, awk, Bourne shell (включая производные: bash, ksh, zsh, pdksh), C, C++, C#, C shell (включая tcsh), COBOL, Expect, Fortran (включая Fortran 90), Haskell, Java, lex (включая flex), LISP (включая Scheme), make-файлы.

 

Существуют инструменты улучшения прогаммного кода, например.

Beautifier — инструмент для создания «красивого» кода. Приводят исходный код к определенному оформлению. При этом логика кода не меняется.

 

CASE средства для UML

 

●IBM Rational Rose (рис. 12)

●Microsoft Visio 2003 и выше

 
 

●Umbrello, Dia (рис. 13)

●Visual Paradigm for UML (рис. 14)

●StarUML (рис. 15),

· ArgoUML (рис. 16).

Рис. 12

 

 

 
 

Рис. 13

Рис. 14

 
 

Рис. 15

Рис. 16

 

Организация работы

 

Важную роль играет организация рабочего места программиста (Рис. 17) и профилактика заболеваний.

Рис. 17

 
 

Для профилактики могут использоваться как медицинские рекомендации, так и компьютерные программы. Например, Workrave — свободное кроссплатформенное программное обеспечение, разработанное для сохранения здоровья человеку, который постоянно находится за компьютером. Эта программа помогает в предупреждении и лечении синдрома запястного канала и снятии общего мышечного напряжения.

 

Среды конструирования программных систем

 

В процессе разработки программных систем используются следующие среды.

Среда проектирования

● Текстовые редакторы;

● Среды визуального моделирования;

● Системы генерации документации;

● Системы сбора и учета требований.

 

Среда разработки

● Инструменты для написания кода;

● Инструменты для проверки корректности кода;

● Инструменты для компиляции кода;

● Механизмы сборки кода;

● Механизмы выполнения кода;

● Механизмы генерации кода;

● VCS.

 

Среда тестирования

● Системы для модульного тестирования;

● Системы для интеграционного тестирования;

● Системы для системного тестирования.

 

Среда выполнения

● Системы резервирования данных;

● Виртуальные среды;

● Облачные среды.

 

Среда сопровождения

● Информационные системы;

● Базы знаний;

● Часто задаваемые вопросы (FAQ);

● Механизмы обновления;

● Системы учета ошибок;

● Системы сбора запросов на сопровождение;

● CRM.

 

Проектирование

 

Структурный анализ - один из формализованных методов анализа требований к ПО. Автор метода – Том Де Марко (1979). Программный продукт рассматривается как преобразователь информационного потока данных. Основной элемент анализа – диаграмма потоков данных. Сущность структурного подхода к разработке ПО заключается в декомпозиции (разбиении) на автоматизируемые функции: система разбивается на функциональные подсистемы, которые в свою очередь делятся на подфункции, подразделяемые на задачи и так далее. Процесс разбиения продолжается вплоть до конкретных процедур.

В структурном анализе используются, в основном, две группы средств, иллюстрирующих функции, выполняемые системой и отношения между данными. Наиболее распространенными являются следующие:

● SADT (Structured Analysis and Design Technique) модели и соответствующие функциональные диаграммы;

● DFD (Data Flow Diagrams) диаграммы потоков данных;

● ERD (Entity-Relationship Diagrams) диаграммы "сущность- связь".

 


 

SADT

 

 
 

Методология SADT разработана Дугласом Россом. На ее основе разработана, в частности, известная методология IDEF0 (Icam DEFinition), которая является основной частью программы ICAM (Интеграция компьютерных и промышленных технологий), проводимой по инициативе ВВС США. Основным элементом диаграммы является функция, общий вид которой приведен не рис. 18.

Рис. 18

 

DFD

 

DFD (ДПД) - графическое средство для изображения информационного потока и преобразований, которым подвергаются данные при движении от входа к выходам системы. Его элементы перечислены в следующей таблице.

При разработке DFD-диаграмм может выполняться постепенное уточнение функций, как при структурном программировании (см. уровни ПДД0 и ПДД1 на рисунке 19).


Рис. 19

 

Связи и переходы изображаются стрелками, как показано в следующей таблице и на рисунке 20.

 

 

 
 

Рис. 20

 

Пример Диаграммы потоков данных приведен на рис. 21.

 
 

Рис. 21

 


 

Метод структурного проектирования

 

Метод может быть проиллюстрирован диаграммой рис. 22 и 23.

 
 

Рис. 22

 
 

Рис. 23

 

Результат преобразования диаграммы рис. 23 показан на рис. 24.

 

Рис. 24

 

Date: 2016-07-18; view: 958; Нарушение авторских прав; Помощь в написании работы --> СЮДА...



mydocx.ru - 2015-2024 year. (0.006 sec.) Все материалы представленные на сайте исключительно с целью ознакомления читателями и не преследуют коммерческих целей или нарушение авторских прав - Пожаловаться на публикацию