Wahl der Leser
Populäre Artikel
Das Benutzerhandbuch wurde auf Basis von GOST 19.504-79 erstellt. Das Programmierhandbuch wird in drei Fällen entwickelt:
– Das Softwareprodukt ist seinem Hauptzweck nach eine Entwicklungsumgebung oder -bibliothek (wie Delphi oder Qt);
– ein Komplex oder ein Softwareprodukt dient als Plattform für die Entwicklung von Programmen oder Systemen eines bestimmten Typs (wie 1C oder Axapta);
– Das Programm wird zusammen mit dem Quellcode verbreitet oder von den Entwicklern selbst ständig modifiziert.
Die offensichtliche Aufgabe des Programmierermanagements besteht darin, dem Entwickler Informationen zur Verfügung zu stellen, die für die Erstellung eigener Programme oder Systeme auf Basis des entwickelten Softwareprodukts ausreichen.
Das Programmierhandbuch sollte Folgendes erklären:
– Mit welchen Objekten sich der Programmierer beschäftigt, wo sie sich befinden, wie lange sie existieren und wie sie miteinander interagieren. Welche davon erstellt er selbst und welche werden ihm zunächst von der Umgebung, dem Framework, der Bibliothek bereitgestellt.
– Welche weiteren Entwicklungswerkzeuge (neben dem entwickelten Softwareprodukt) benötigt werden, um eine Anwendung oder ein System zu erstellen? Handelt es sich bei dem entwickelten Softwareprodukt beispielsweise um eine Bibliothek, benötigt der Programmierer einen Compiler, eine Art Entwicklungsumgebung und andere Tools.
– In welcher Umgebung die Anwendung oder das System betrieben wird. Was sind die Mindestsystemanforderungen? Benötigen Sie zusätzliche Software, um es auszuführen: Frameworks, Laufzeiten, Interpreter?
– Was ist eine minimal funktionsfähige Anwendung oder ein minimal funktionsfähiges System? Welche Objekte müssen in welcher Reihenfolge erstellt werden, wie werden sie miteinander verbunden, damit die Anwendung einen Teil ihrer minimalen Ausgabe ausführen kann?
– Wie (Schritt für Schritt) eine funktionierende Anwendung kompiliert oder ein funktionierendes System bereitgestellt wird.
Darüber hinaus muss das Programmierhandbuch vollständige Beschreibungen aller im Softwareprodukt bereitgestellten Objekte enthalten. Wenn es sich um Funktionen handelt, sollten deren Zusammenfassungen angegeben werden, wenn es sich um Klassen handelt, Beschreibungen ihrer Schnittstellen usw.
Wenn ein Softwareprodukt die Verwendung einer Originalprogrammiersprache beinhaltet und mit einem eigenen Compiler oder Interpreter ausgestattet ist, muss eine Beschreibung davon in das Programmierhandbuch aufgenommen werden.
Im Text der Anleitung sind folgende Regeln zu beachten:
– Wenn Sie ein neues Konzept einführen, sollten Sie sich nur auf Konzepte verlassen, die bereits früher eingeführt wurden oder dem Leser offensichtlich bekannt sind.
– Die Einführung jedes Konzepts muss in irgendeiner Weise begründet werden.
Die Hauptanforderung bei der Beschreibung einzelner Objekte ist die Vollständigkeit der Beschreibung jedes einzelnen Objekts.
Bei der Beschreibung von Objekten sollte besonderes Augenmerk auf folgende Aspekte gelegt werden:
– Was der Erstellung und Nutzung eines Objekts unbedingt vorausgehen muss.
– Welche Nebenwirkungen hat der Zugriff auf das Objekt?
– Merkmale der Interpretation der ihm übermittelten Daten durch das Objekt.
– Wo „physisch“ (in welcher Datei, in welcher Bibliothek) sich das Objekt befindet.
– Es empfiehlt sich, für jedes Objekt Anwendungsbeispiele bereitzustellen, kleine Codefragmente, die die Erstellung des Objekts (falls es vor der Verwendung erstellt werden muss), die Weitergabe von Eingabedaten an das Objekt, den Empfang von Ausgabedaten und deren Interpretation veranschaulichen.
Es ist möglich, das Programmierhandbuch im Hypertext auszuführen.
Struktur des Programmierhandbuchs:
1. Zweck und Nutzungsbedingungen des Programms.
2. Merkmale des Programms.
3. Zugriff auf das Programm.
4. Eingabe- und Ausgabedaten.
5. Nachrichten.
Das Programmierhandbuch kann mit verschiedenen Diagrammen ergänzt werden, beispielsweise Datenbankdiagrammen, Klassendiagrammen und Aufrufdiagrammen
Als Beispiel wird der Inhalt des E-Port-Händler-Systemprogrammiererhandbuchs vorgestellt. Client-Server-Protokoll.
Das System „E-Port-Händler“ ist für den Empfang und die Durchführung von Sofortzahlungen bei der Bezahlung von Mobilfunkdiensten, Internetzugang usw. konzipiert. Der zentrale Server des Systems gehört zur E-Port-Gruppe und jeder kann eine Zahlungsakzeptanzstelle eröffnen indem sie das Client-Programm auf ihrem Computer (mit Internetverbindung) installieren. Der Datenaustausch zwischen dem zentralen Server und dem Client-Programm erfolgt über ein spezielles Protokoll. Das Protokoll ist offen und ermöglicht es verschiedenen Organisationen: Banken, Einzelhandelsketten, Netzwerke von Zahlungsterminals, Zahlungen direkt über ihre eigenen Systeme zu tätigen. Das Protokoll wurde von der e-port Group entwickelt und die technische Dokumentation wurde von Philosoft in Auftrag gegeben.
EINFÜHRUNG
E-Port-Händlersystem: Client-Server-Protokoll. Zweck und Überblick über die Fähigkeiten
Protokollziele
Hauptvorteile der Verwendung des Protokolls
1 Protokollimplementierung (Gateway)
1.1 Allgemeine Informationen
1.2 Anwendungsstruktur
2. Wie das Gateway funktioniert
2.1 Registrierung und Berichterstattung
2.1.1 Registrierung
2.1.2 Berichterstattung
2.2 Datenaustausch mit dem Server
2.2.1 Paketstruktur
2.2.2 Verzeichnisse
2.2.3 Reihenfolge des Paketaustauschs
2.3 Vorgangsverarbeitungszyklus
2.3.2 Warteschlange
2.3.3 Analyse der Serverantwort
2.3.4 Nicht standardmäßige Situationen
3 Protokollspezifikation
3.1 Strukturelemente des Pakets
3.2 Anforderungsheader
3.3 Antwortheader
3.4 Kontoauffüllung
3.5 Kauf eines PIN-Codes
3.6 Unterbrechen des Transaktionsverarbeitungsprozesses
3.7 Transaktionseigenschaften der Operation
3.9 Verzeichnis
3.11 Betriebsstatus
3.11.1 Beispiele für Transaktionsstatusmeldungen
3.11.2 Statuscodes für ausstehende oder abgeschlossene Transaktionen
3.11 Systembenachrichtigungen
4 GLOSSAR
ANWENDUNGEN
Anhang 1. XML-Anfrage-DTD und Kommentar
Das Programmierhandbuch wird in drei Fällen entwickelt:
Sie können sich sicherlich auch andere Situationen vorstellen (z. B. ein Softwareprodukt ist ein Betriebssystem), aber im Leben kommen sie viel seltener vor.
Die offensichtliche Aufgabe des Programmierermanagements besteht darin, dem Entwickler Informationen zur Verfügung zu stellen, die für die Erstellung eigener Programme oder Systeme auf Basis unseres Softwareprodukts ausreichen. Ein weiteres Motiv für die Erstellung eines solchen Dokuments ist die Notwendigkeit, dass Entwickler von Zeit zu Zeit den Status des Produkts aufzeichnen, um sich darin nicht zu verwirren und keine Träger von „heiligem Wissen“ im Team zu produzieren.
Das Programmierhandbuch sollte Folgendes erklären:
Dies sind grundlegende Fragen, ohne Antworten, auf die ein Programmierer nicht normal arbeiten kann. Werden sie ihm nicht explizit mitgeteilt, wird er zur Recherche gezwungen. Aber es gibt noch viele weitere: Debugging-Methoden und -Techniken, Programmierstil usw.
Neben der Theorie muss das Programmierhandbuch vollständige Beschreibungen aller im Softwareprodukt bereitgestellten Objekte enthalten. Wenn es sich um Funktionen handelt, sollten deren Zusammenfassungen angegeben werden, wenn es sich um Klassen handelt, Beschreibungen ihrer Schnittstellen usw.
Wenn ein Softwareprodukt die Verwendung einer Originalprogrammiersprache beinhaltet und mit einem eigenen Compiler oder Interpreter ausgestattet ist, muss eine Beschreibung davon in das Programmierhandbuch aufgenommen werden. Wenn es sich jedoch als sehr umfangreich herausstellt, wird es in einem separaten Dokument zusammengefasst, das den Namen „Beschreibung der Sprache (Programmierung)“ trägt.
Die wichtigsten methodischen Anforderungen an den theoretischen Teil des Programmierhandbuchs sind Logik und Konsistenz der Darstellung. Im Text sind insbesondere folgende Regeln zu beachten:
Die Hauptanforderung bei der Beschreibung einzelner Objekte ist die Vollständigkeit der Beschreibung jedes einzelnen Objekts. Im Gegensatz zum Benutzerhandbuch, bei dessen Zusammenstellung man grundsätzlich auf den Einfallsreichtum des Lesers zählen kann, der sich die Schnittstelle anschaut und es selbst herausfindet, beschreibt das Programmierhandbuch sehr nicht offensichtliche Dinge. Und obwohl man vom Programmierer erwarten kann, dass er einfühlsamer ist als vom Benutzer, muss er den Mangel an Informationen durch die Analyse des Quelltexts ausgleichen, und wenn dieser verfügbar ist, dann durch das Testen der „Black Box“ und eines Debuggers. Dies ist ein viel längerer Prozess als das Durchsuchen von Menüs und Dialogfeldern.
Bei der Beschreibung von Objekten sollte besonderes Augenmerk auf folgende Aspekte gelegt werden:
Es empfiehlt sich, für jedes Objekt Anwendungsbeispiele bereitzustellen, kleine Codefragmente, die Folgendes veranschaulichen:
Beschreibungen von Objekten können in einem separaten Band oder Dokument namens „Programmer's Handbook“ abgelegt werden. Eine gute Idee ist es, es als Hypertext zu verwenden.
Zwischen dem theoretischen Teil und dem Nachschlagewerk zu Objekten ist es sinnvoll, einen kleinen Abschnitt zu platzieren, in dem ein Beispiel einer kleinen, aber aus Sicht der verwendeten Plattform vollständigen Anwendung betrachtet wird. Das Beispiel sollte so beschaffen sein, dass der Leser diese Anwendung selbstständig reproduzieren, debuggen und ausführen kann. Um dies zu erreichen, muss dies natürlich zunächst von einem der Autoren des Programmierhandbuchs durchgeführt werden.
Die Struktur des in GOST 19.504-79 festgelegten Programmierhandbuchs ist wie folgt:
Eine solche Struktur erweckt unter modernen Bedingungen nicht den Eindruck, nützlich zu sein. Vielmehr kann mit diesem Plan ein separates Objekt, beispielsweise eine Funktion oder Klasse, beschrieben werden. Wir verpflichten uns nicht, eine Standardstruktur eines Programmierhandbuchs für alle Gelegenheiten zu erstellen. Höchstwahrscheinlich wird es oberflächlich und ebenso wenig nützlich sein. Stattdessen hier zwei Beispielstrukturen:
Ein vollständiger Leitfaden für Programmierer kann nur von einem Autor verfasst werden, der über eigene Erfahrung in der professionellen Programmentwicklung verfügt.
Das Programmierhandbuch kann mit verschiedenen Diagrammen ergänzt werden, beispielsweise Datenbankdiagrammen, Klassendiagrammen, Funktionsaufrufgraphen (siehe Beispiel).
Das Analysesoftwarepaket „Nostradamus“ ist für die Erstellung von Analyse- und Reporting-Banking-Systemen konzipiert. Es enthält eine Reihe spezialisierter Komponenten, aus denen der Entwickler eine Anwendung in einer visuellen Umgebung erstellt. Bei Bedarf kann der Programmcode in Pascal geschrieben werden (eine Beschreibung der Programmiersprache ist daher nicht erforderlich). Das Softwarepaket wurde von ProgramBank entwickelt, und technische Dokumentation von Philosoft auf ihren Befehl hin. Neben dem Programmierhandbuch umfasst das Dokumentationsset ein umfassendes Nachschlagewerk zu allen Komponenten des agroindustriellen Komplexes.
1. Allgemeine Informationen 1.1. Abkürzungen 1.2. Zweck 1.3. Funktionalität 1.4. Nutzungsbedingungen 1.5. Anforderungen an die Entwicklerqualifikation 2. Anwendungslösung und ihre Komponenten 2.1. Architektur des agroindustriellen Komplexes „Nostradamus“. Konzept einer angewandten Lösung 2.2. Anforderungen an die Anwendungslösung 2.2.1. Grundvoraussetzungen 2.2.2. Anforderungen an Eingabedaten 2.2.3. Anforderungen an Datenberechnungsalgorithmen 2.2.4. Anforderungen an Berichte und deren Satz 2.2.5. Anforderungen an Zugangskontrolle und Informationssicherheit 2.3. Komponenten der Anwendungslösung 2.3.1. Datenbankstruktur 2.3.2. Laden von Quelldaten 2.3.3. Gestaltung der Benutzeroberfläche 2.3.4. Arbeit des Benutzers mit Daten 2.3.5. Datenverarbeitung und Berechnung 2.3.6. Datenanzeige 2.3.7. Tools zum automatischen Laden und Verarbeiten von Daten. Systemagent 2.4. Differenzierung der Zugriffsrechte in einer Anwendungslösung 2.4.1. Benutzerrollen 2.4.2. Benutzerprofile 2.5. Lebenszyklus einer Anwendungslösung 3. Beispiel einer Anwendungslösung 3.1. Formulierung des Problems. Ermittlung der Anforderungen an eine Anwendungslösung 3.2. Entwurf einer Anwendungslösung 3.2.1. Entwerfen von Tabellenstrukturen und Datenladeverfahren 3.2.2. Design der Benutzeroberfläche 3.2.3. Gestaltung von Berechnungsverfahren und Berichten 3.3. Implementierung einer Anwendungslösung 3.3.1. Autorisierung in APK „Nostradamus“ 3.3.2. Erstellung einer Lösungskategorie 3.3.3. Tabellen erstellen 3.3.4. Erstellen von Datenladeprozeduren 3.3.5. Erstellung von Verzeichnissen und visuellen Formularen dafür 3.3.6. Berechnungsprozeduren in der Sprache gespeicherter Datenbankprozeduren erstellen 3.3.7. Berichte erstellen 3.3.8. Benutzergruppen erstellen und ein Hauptmenü für diese erstellen 3.3.9. Erstellen eines Verfahrens zum automatischen Aktualisieren (Herunterladen) von Daten mithilfe eines Systemagenten 3.4. Bereitstellung einer Anwendungslösung 3.5. Testen der Anwendungslösung 3.6. Verkomplizierung des Problems 3.7. Finalisierung der Anwendungslösung 3.7.1. Erstellen eines interaktiven Berichts 3.7.2. Erstellen eines interaktiven Downloads 3.7.3. Die letzte Phase der Verbesserung der Anwendungslösung
Das System „E-Port-Händler“ ist für den Empfang und die Durchführung von Sofortzahlungen bei der Bezahlung von Mobilfunkdiensten, Internetzugang usw. konzipiert. Der zentrale Server des Systems gehört zur E-Port-Gruppe und jeder kann eine Zahlungsakzeptanzstelle eröffnen indem sie das Client-Programm auf ihrem Computer (mit Internetverbindung) installieren. Der Datenaustausch zwischen dem zentralen Server und dem Client-Programm erfolgt über ein spezielles Protokoll. Das Protokoll ist offen und ermöglicht es verschiedenen Organisationen: Banken, Einzelhandelsketten, Netzwerke von Zahlungsterminals, Zahlungen direkt über ihre eigenen Systeme zu tätigen. Das Protokoll wurde von der e-port Group entwickelt, und technische Dokumentation von Philosoft auf ihren Befehl hin.
Einleitung i. E-Port-Händlersystem: Client-Server-Protokoll. Zweck und Überblick über die Fähigkeiten ii. Protokollziele iii. Hauptvorteile der Verwendung des Protokolls 1. Protokollimplementierung (Gateway) 1.1. Allgemeine Informationen 1.2. Anwendungsstruktur 2. Funktionsweise des Gateways 2.1. Registrierung und Berichterstattung 2.1.1. Registrierung 2.1.2. Berichterstattung 2.2. Datenaustausch mit dem Server 2.2.1. Paketstruktur 2.2.2. Verzeichnisse 2.2.3. Paketaustauschverfahren 2.3. Vorgangsverarbeitungszyklus 2.3.1. Betriebsanforderung 2.3.2. Warteschlange 2.3.3. Analyse der Serverantwort 2.3.4. Nicht standardmäßige Situationen 3. Protokollspezifikation 3.1. Strukturelemente des Pakets 3.2. Anforderungsheader 3.3. Antwortheader 3.4. Kontoauffüllung 3.5. Erwerb eines PIN-Codes 3.6. Unterbrechung der Transaktionsverarbeitung 3.7. Transaktionseigenschaften der Operation 3.8. Antrag auf Mehrfachoperationen 3.9. Handbuch 3.10. Betriebsstatus 3.10.1. Beispiele für Meldungen zum Betriebsstatus 3.10.2. Statuscodes für ausstehende oder abgeschlossene Transaktionen 3.11. Systembenachrichtigungen 4. Glossar Anwendungen Anhang 1. XML-Anfrage-DTD und Kommentar XML-Anfrage-DTD Kommentar Anhang 2. XML-Antwort-DTD Anhang 3. Regeln zur Berechnung von Summenfeldern Anhang 4. Beispiele für Serveranfragen und -antworten
Das Programmierhandbuch bezieht sich auf die betriebliche und technische Dokumentation und ist in Fällen erforderlich, in denen das System auf die eine oder andere Weise die Möglichkeit bietet, Programmcode zu schreiben, zu bearbeiten oder zu verwenden.
Beispiele beinhalten:
– Funktionsbibliothek;
– Plattform oder Umgebung für die Softwareentwicklung;
- Quelloffene Software.
Das Dokument muss alle notwendigen Informationen enthalten, damit der Entwickler die Fähigkeiten des Systems nutzen kann. Um dieses Problem zu lösen, kann der Inhalt des Dokuments Folgendes umfassen:
– Zweck, Struktur der Ein- und Ausgabedaten von Softwarefunktionen;
– Möglichkeiten zur Erstellung von Programmcode, Merkmale seiner Interpretation und Kompilierung;
– syntaktische Merkmale der verwendeten Programmiersprache;
– mögliche Regeln und Einschränkungen beim Arbeiten mit Programmcode;
– verschiedene Anleitungen zum Arbeiten mit dem Programm.
Die Liste der möglichen Themen ist nicht darauf beschränkt, sondern hängt alles von den Eigenschaften eines bestimmten Systems ab. Es muss gesagt werden, dass das Programmierhandbuch für Systementwickler sehr nützlich sein kann, da es als Referenz für die aktuelle Implementierung der Betriebslogik der Software dient.
Zusammenstellung eines Standardhandbuchs für Programmierer
Gemäß den GOST-Anforderungen muss das Programmierhandbuch die folgenden Abschnitte enthalten:
– Zweck und Nutzungsbedingungen des Programms , wobei sie den Umfang der Software und die für ihren Betrieb erforderlichen technischen Voraussetzungen angeben.
– Programmeigenschaften , wo sie die Funktionsweise des Programms, seine Geschwindigkeitsanzeigen und andere für die Nutzung wichtige Eigenschaften beschreiben.
– Zugang zum Programm , wo sie die Methoden und Parameter zum Starten des Programms angeben;
– Eingabe- und Ausgabedaten , wo sie das Format, die Organisationsmethode und andere Anforderungen für Eingabe- und Ausgabedaten beschreiben;
– Mitteilungen , das die Texte der vom Programm in verschiedenen Situationen ausgegebenen Meldungen und die zu ergreifenden Maßnahmen bereitstellt.
Es empfiehlt sich, dem Dokument im Anhang verschiedene Beispiele, Abbildungen und Tabellen beizufügen.
Standards des Programmierhandbuchs
GOSTs regeln auch dieses Dokument, in diesem Fall ist es GOST 19.504. (Anhang 1) In Übereinstimmung damit werden Struktur und Inhalt des Programmierhandbuchs festgelegt.
Ich habe Microsoft Visual Studio verwendet, um die Anwendung zu entwickeln. Um mit der Entwicklung zu beginnen, klicken Sie auf Datei --- Neu --- Projekt erstellen --- WPF-Anwendung. Es öffnet sich ein leeres Formular. Auf dem Formular habe ich einen Hintergrund platziert (das Bild für den Hintergrund habe ich zuvor in die Ressourcen des zukünftigen Programms geladen), Label-Komponenten (Inhaltseigenschaft Willkommensnachricht), TextBox (hier wird der Name der getesteten Person eingegeben), Button Schaltflächen zum Aufrufen der Hilfe und zum Starten des Tests. Ich gruppiere alle Formularkomponenten in Canvas. Durch Klicken auf die Schaltfläche „Hilfe“ wird ein Hilfeformular aufgerufen, auf dem sich eine TextBox mit Hilfe zur Verwendung des Programms und eine Schaltfläche zum Zurückkehren zum Startformular befinden.
Hello.Visibility = Visibility.Hidden;//Elemente des Startformulars ausblenden
Spravka.Visibility = Visibility.Visible;//Hilfefenster anzeigen
Hello.Visibility = Visibility.Visible;//zeige das Startformularfenster an
Spravka.Visibility = Visibility.Hidden;//Hilfeformularelemente ausblenden
Wenn Sie auf die Schaltfläche „Test starten“ klicken, öffnet sich, sofern das Namenseingabefeld ausgefüllt ist, ein Testfenster, in dem sich eine TextBox befindet, in der Fragen angezeigt werden, eine ListBox, in der Antwortoptionen angezeigt werden, und das „ Schaltflächen „Nächste Frage“ und „Vorherige Frage“. Wenn das Namenseingabefeld nicht ausgefüllt ist, wird eine Meldung angezeigt, dass die erforderlichen Felder nicht ausgefüllt sind.
subjectName = User.Text;
if (!string.IsNullOrEmpty(subjectName) && !string.IsNullOrEmpty(testFilePath)) // prüfen, ob das Feld gefüllt ist
xmlLoad(); //Lade eine Datei mit Fragen
MessageBox.Show("Erforderliche Felder sind nicht ausgefüllt");//eine Fehlermeldung anzeigen
countSteps = qstns.Count();
Answer.Items.Clear();
Am Ende des Tests öffnet sich das Formular mit den Testergebnissen, in dem sich ein Textfeld mit dem Testergebnis sowie die Schaltflächen „Von vorne beginnen“ und „Beenden“ befinden.
if (_step == countSteps)
Prev.Content = "Exit";
Fragen.Text = Nachricht;
LoadStep(_step, beforeStep);
Der vollständige Programmcode mit Kommentaren befindet sich in Anhang 2
ABSCHLUSS
Während meines Praktikums habe ich meine Kenntnisse in der Entwicklungsumgebung der Programmiersprache C# erweitert.
Alle Übungsziele wurden erreicht:
¾ Erweiterung, Vertiefung und Systematisierung der im Rahmen der theoretischen Ausbildung erworbenen Kenntnisse;
¾ Festigung praktischer Fähigkeiten in der Entwicklung und Änderung von Informationssystemen;
¾ Ausbildung beruflicher Kompetenzen.
Alle Übungsaufgaben abgeschlossen, nämlich:
¾ sich mit den Arbeitsbedingungen des Unternehmens und seines Arbeitsplatzes vertraut gemacht hat, insbesondere mit den internen Regeln, Sicherheitsanforderungen, physiologischen und hygienischen Grundlagen des Arbeitsprozesses und Hygieneanforderungen;
¾ studierte normative und methodische Materialien, Grundlagen- und Zeitschriftenliteratur entsprechend der individuellen Aufgabenstellung;
¾ genutzte Informations- und Kommunikationstechnologien;
¾ haben sich für ein Softwareentwicklungstool entschieden;
¾ eine individuelle Aufgabe abgeschlossen (ein Testprogramm entwickelt);
¾ erstellte einen Bericht über die Praxis.
LISTE DER QUELLEN
1. Jon Skeet. C# für Profis: Feinheiten der Programmierung, 3. Auflage, neue Übersetzung = C# in Depth, 3. Auflage. - M.: Williams, 2014. - 608 S.
2. Christian Nagel et al. C# 5.0 und die .NET 4.5-Plattform für Profis = Professional C# 5.0 und .NET 4.5. - M.: „Dialektik“, 2013. - 1440 S.
3. Joseph Albahari, Ben Albahari. C# 6.0. Verzeichnis. Vollständige Beschreibung der Sprache = C# 5.0 auf den Punkt gebracht: Die endgültige Referenz. - M.: „Williams“, 2015. - 1008 S.
4. https://habrahabr.ru/
5. http://www.cyberforum.ru/
ANWENDUNGEN
ANHANG 1
G O S U D A R S T V E N N Y S T A N D A R T S O Y W A S S R
Einheitliches System der Programmdokumentation | GOST 19.504-79* (ST SEV 2095-80) |
PROGRAMMIERHANDBUCH. ANFORDERUNGEN AN INHALT UND GESTALTUNG | |
Vereinigtes System zur Programmdokumentation. Programmierhandbuch. Anforderungen an Inhalt und Darstellungsform |
Durch den Beschluss Nr. 74 des Staatlichen Normenkomitees des Ministerrats der UdSSR vom 12. Januar 1979 wurde der Einführungstermin festgelegt
Vom 01.01. 1980
Diese Norm legt Anforderungen an den Inhalt und die Gestaltung des Programmdokuments „Programmer’s Guide“ fest, definiert durch GOST 19.101-77.
Der Standard entspricht vollständig ST SEV 2095-80.
ALLGEMEINE BESTIMMUNGEN
1.1. Struktur und Format des Dokuments werden gemäß GOST 19.105-78 festgelegt.
Die Erstellung des Informationsteils (Anmerkungen und Inhalte) ist obligatorisch.
1.2. Das Programmierhandbuch sollte die folgenden Abschnitte enthalten:
· Zweck und Anwendungsbedingungen der Programme;
· Merkmale des Programms;
· Zugang zum Programm;
· Eingabe- und Ausgabedaten;
· Mitteilungen.
Abhängig von den Besonderheiten der Dokumente ist es möglich, einzelne Abschnitte zusammenzufassen oder neue einzuführen.
2.1. Im Abschnitt „Zweck und Bedingungen für die Nutzung von Programmen“ müssen der Zweck und die vom Programm ausgeführten Funktionen sowie die für die Ausführung des Programms erforderlichen Bedingungen (Größe des Arbeitsspeichers, Anforderungen an die Zusammensetzung und Parameter) angegeben werden
Peripheriegeräte, Softwareanforderungen usw.).
2.2. Der Abschnitt „Programmmerkmale“ sollte eine Beschreibung der wichtigsten Merkmale und Merkmale des Programms enthalten (Zeitverhalten, Betriebsmodus, Mittel zur Überwachung der korrekten Ausführung und Selbstheilung des Programms usw.).
2.3. Der Abschnitt „Zugriff auf das Programm“ sollte eine Beschreibung der Verfahren zum Aufruf des Programms (Methoden zur Übertragung von Steuer- und Datenparametern usw.) enthalten.
2.4. Im Abschnitt „Ein- und Ausgabedaten“ sollte die Organisation der verwendeten Ein- und Ausgabeinformationen und ggf. deren Kodierung beschrieben werden.
2.5. Der Abschnitt „Nachrichten“ sollte die Texte der Nachrichten enthalten, die während der Programmausführung an den Programmierer oder Bediener ausgegeben werden, eine Beschreibung ihres Inhalts und die Maßnahmen, die als Reaktion auf diese Nachrichten ergriffen werden müssen.
2.6. Der Anhang zum Programmierhandbuch kann zusätzliche Materialien (Beispiele, Abbildungen, Tabellen, Grafiken usw.) enthalten.
* Neuauflage (November 1987) mit Änderung Nr. 1, genehmigt im September 1981 (IUS 11-81)
ANLAGE 2
mit System.Collections.Generic;
mit System.IO;
mit System.Linq;
Verwenden von System.Text;
Verwenden von System.Threading.Tasks;
mit System.Windows;
Verwenden von System.Windows.Controls;
Verwenden von System.Windows.Data;
Verwenden von System.Windows.Documents;
mit System.Windows.Input;
Verwenden von System.Windows.Media;
mit System.Windows.Media.Imaging;
Verwenden von System.Windows.Navigation;
Verwenden von System.Windows.Shapes;
mit System.Xml;
mit System.Xml.Linq;
Namespace Selbsttester
///
/// Interaktionslogik für MainWindow.xaml
///
öffentliche Teilklasse MainWindow: Window
string subjectName = "";//Variablenname der getesteten Person
private int _step;// Lokale Testschrittvariable
int countSteps;// Anzahl der Fragen im Test (dynamisch aus der ausgewählten Testdatei erhalten)
XDocument mainXml = new XDocument(); // Initialisieren Sie das XML-Dokumentobjekt, um die Testdatei zu lesen
Aufführen
Aufführen
Aufführen
//string testFilePath = "";
int step // Globale Schrittvariable
return _step;// Den Wert der lokalen Variablen „step“ abrufen
var beforeStep = _step; // Den vorherigen Schritt festlegen
Step = value; // Aktuellen Schritt festlegen
if (_step == countSteps + 1) // Prüfung, ob der aktuelle Schritt gleich der Gesamtzahl der Schritte ist, Aktion auf der Schaltfläche, um erneut zu beginnen
score.Clear();// Die gesammelten Punkte löschen
Answer.Visibility = Visibility.Visible; // Zeigt die ListBox an, in der wir die Antworten auf die aktuelle Frage anzeigen
Schritt = 0;//Gehe wieder zu Schritt Null
if (_step == 0) // Prüfe, ob unser Schritt Null ist
Prev.Content = „Exit“;// Dem Button „Vorherige Frage“ den Wert „Exit“ zuweisen
sonst wenn (_step< 0)// Проверяем шаг меньше ли нуля
Close();//Schließe das Programm
Prev.Content = „Zurück“; // Dem Button „Vorherige Frage“ den Wert Zurück „Vorherige Frage“ zuweisen
if (_step > 0) // Wenn der Schritt größer als Null ist
var _answers = Antworten[_step - 1].Elements().ToList();// Schreibe alle Antwortoptionen auf die aktuelle Frage in eine Variable
var selectedIndex = Answer.SelectedIndex; // Mal sehen, welche Antwortoption im letzten Schritt ausgewählt wurde
var index = beforeStep;
var val = (selectedIndex != -1) ? (_answers.Attribute("true-answer") != null && _answers.Attribute("true-answer").Value == "true") ? 1: 0: 0;// Проверяем был ли ответ правильным!}
if (score.Contains(_step))// Mal sehen, ob wir die Frage früher beantwortet haben
score[_step] = val;// Für die vorherige Frage festlegen, die wir richtig beantwortet haben
score.Add(val);// Für die vorherige Frage festlegen, die wir richtig beantwortet haben
/*Ausgabe, wenn die Testergebnisse die letzte Frage beantwortet haben*/
if (_step == countSteps)
Next.Content = "Von vorne beginnen";
Prev.Content = "Exit";
string sum = score.Sum().ToString();
string numeric = GetDeclension(int.Parse(sum), „richtige Antwort“, „richtige Antworten“, „richtige Antworten“);
string message = „Dear“ + subjectName + „. Vielen Dank, dass Sie den Test gemacht haben. Ihr Ergebnis ist „ + sum + „ „ + numeric + „ from „ + countSteps;
Fragen.Text = Nachricht;
Answer.Visibility = Visibility.Hidden;
LoadStep(_step, beforeStep);
string testFilePath = "Resources/testTest.xml";
öffentliches MainWindow()
Initialisieren der Komponente();
Test.Visibility = Visibility.Hidden;
void loadStep(int _locStep, int beforeStep)
foreach (var curEl in mainXml.Root.Element("questions").Elements())
Questions.Text = questionsList[_locStep];
Answer.Items.Clear();
var currentAnswers = Antworten[_locStep];
foreach (var-Antwort in currentAnswers.Elements())
Answer.Items.Add(answer.Value);
öffentlicher statischer String GetDeclension(int number, string nominativ, string genetiv, string plural)
Zahl = Zahl % 100;
if (Zahl >= 11 && Zahl<= 19)
var i = Zahl % 10;
Nominativ zurückgeben;
private void prevButton_Click(object sender, RoutedEventArgs e)
if (Prev.Content.ToString().Trim() == "Exit")
private void nextButton_Click(object sender, RoutedEventArgs e)
mainXml = XDocument.Load(testFilePath);
var qstns = mainXml.Root.Element("questions").Elements();
countSteps = qstns.Count();
foreach (var-Frage in qstns)
questionsList.Add(question.Element("text").Value);
antworten.Add(question.Element("answers"));
private void Button_Click(object sender, RoutedEventArgs e)
subjectName = User.Text;
if (!string.IsNullOrEmpty(subjectName) && !string.IsNullOrEmpty(testFilePath))
Start.Visibility = Visibility.Hidden;
Test.Visibility = Visibility.Visible;
MessageBox.Show("Erforderliche Felder sind nicht ausgefüllt");
private void spravkaButton_Click(object sender, RoutedEventArgs e)
Hello.Visibility = Visibility.Hidden;
Help.Visibility = Visibility.Visible;
private void closeSpravkaButton_Click(object sender, RoutedEventArgs e)
Hello.Visibility = Visibility.Visible;
Help.Visibility = Visibility.Hidden;
Wenn die Software zusätzlich zur Nutzung und Konfiguration die Möglichkeit bietet, Programmcode zu schreiben, zu bearbeiten oder zu nutzen. Welches Dokument wird in diesem Fall benötigt?
Das Programmierhandbuch bezieht sich auf die betriebliche und technische Dokumentation und ist in Fällen erforderlich, in denen das System auf die eine oder andere Weise die Möglichkeit bietet, Programmcode zu schreiben, zu bearbeiten oder zu verwenden.
Beispiele beinhalten:
– Funktionsbibliothek;
– Plattform oder Umgebung für die Softwareentwicklung;
- Quelloffene Software.
Das Dokument muss alle notwendigen Informationen enthalten, damit der Entwickler die Fähigkeiten des Systems nutzen kann. Um dieses Problem zu lösen, kann der Inhalt des Dokuments Folgendes umfassen:
– Zweck, Struktur der Ein- und Ausgabedaten von Softwarefunktionen;
– Möglichkeiten zur Erstellung von Programmcode, Merkmale seiner Interpretation und Kompilierung;
– syntaktische Merkmale der verwendeten Programmiersprache;
– mögliche Regeln und Einschränkungen beim Arbeiten mit Programmcode;
– verschiedene Anleitungen zum Arbeiten mit dem Programm.
Die Liste der möglichen Themen ist nicht darauf beschränkt, sondern hängt alles von den Eigenschaften eines bestimmten Systems ab. Es muss gesagt werden, dass das Programmierhandbuch für Systementwickler sehr nützlich sein kann, da es als Referenz für die aktuelle Implementierung der Betriebslogik der Software dient.
Gemäß den GOST-Anforderungen muss das Programmierhandbuch die folgenden Abschnitte enthalten:
– Zweck und Nutzungsbedingungen des Programms, wobei sie den Umfang der Software und die für ihren Betrieb erforderlichen technischen Voraussetzungen angeben.
– Programmeigenschaften, wo sie die Funktionsweise des Programms, seine Geschwindigkeitsanzeigen und andere für die Nutzung wichtige Eigenschaften beschreiben.
– Zugang zum Programm, wo sie die Methoden und Parameter zum Starten des Programms angeben;
– Eingabe- und Ausgabedaten, wo sie das Format, die Organisationsmethode und andere Anforderungen für Eingabe- und Ausgabedaten beschreiben;
– Mitteilungen, das die Texte der vom Programm in verschiedenen Situationen ausgegebenen Meldungen und die zu ergreifenden Maßnahmen bereitstellt.
Es empfiehlt sich, dem Dokument im Anhang verschiedene Beispiele, Abbildungen und Tabellen beizufügen.
GOSTs regeln auch dieses Dokument, in diesem Fall ist es GOST 19.504. Dementsprechend werden Aufbau und Inhalt des Programmierhandbuchs festgelegt.
Die Erstellung eines Programmierhandbuchs erfordert hochqualifizierte Fachkräfte und Kenntnisse auf dem Gebiet der Programmierung. Für professionelle Entwickler erscheint eine solche Arbeit jedoch meist langweilig und mühsam, außerdem erfordert sie die Fähigkeit, den Stoff kompetent zu formulieren und klar zu vermitteln. Die Spezialisten von TechRightConsult verfügen über umfangreiche Erfahrung in beiden Bereichen, die es uns ermöglicht, Dokumente zu einem erschwinglichen Preis und termingerecht zu erstellen!
Nachfolgend finden Sie ein Beispiel (Muster) des Dokuments „ Benutzerhandbuch", entwickelt auf Basis der Richtlinien RD 50-34.698-90.
Dieses Dokument wird von einem IT-Spezialisten, einem Funktionsspezialisten oder einem technischen Redakteur während der Entwicklung der Arbeitsdokumentation für das System und seine Teile in der Phase „Arbeitsdokumentation“ erstellt.
Für die Erstellung des Benutzerhandbuchs wurde das Tool als Beispiel herangezogen Oracle Discoverer Informations- und Analysesystem „Corporate Data Warehouse“.
Nachfolgend finden Sie die Zusammensetzung des Benutzerhandbuchs gemäß GOST. Kurz in jedem Abschnitt Die inhaltlichen Anforderungen und der Text des Ausfüllbeispiels sind angegeben.(hervorgehoben durch eine vertikale Linie).
Abschnitte des Benutzerhandbuchs:
Geben Sie im Abschnitt „Einleitung“ Folgendes an:
Die Anforderungen dieses Dokuments gelten, wenn:
Das Informations- und Analysesystem Corporate Data Warehouse (IAS KHD) soll die Technologie optimieren, um taktische und strategische Managemententscheidungen durch Endbenutzer auf der Grundlage von Informationen über alle Aspekte der finanziellen und wirtschaftlichen Aktivitäten des Unternehmens zu treffen.
IAS QCD bietet die Möglichkeit, mit regulierter und unregulierter Berichterstattung zu arbeiten.
Bei der Arbeit mit der Berichterstellung wird das Benutzertool Oracle Discoverer Plus verwendet, das die folgenden Funktionen bietet:
Der IAS QCD-Benutzer muss Erfahrung im Umgang mit MS Windows-Betriebssystemen (95/98/NT/2000/XP), Kenntnisse im Umgang mit Internet Explorer und der Oracle Discoverer-Software haben und außerdem über die folgenden Kenntnisse verfügen:
Die Qualifikation des Benutzers muss Folgendes ermöglichen:
Geben Sie im Abschnitt „Zweck und Nutzungsbedingungen“ Folgendes an:
Oracle Discoverer Plus ist als Teil des IAS QCD darauf ausgelegt, die Vorbereitung und Anpassung von Berichtsformularen für Leistungsindikatoren sowie für eine detaillierte Datenrecherche auf der Grundlage von Unternehmens-Data-Warehouse-Informationen zu automatisieren.
Die Arbeit mit Oracle Discoverer Plus als Teil des IAS QCD ist immer dann möglich, wenn Bedarf besteht, Informationen zur Analyse, Steuerung, Überwachung und darauf basierenden Entscheidungsfindung zu erhalten.
Die Arbeit mit Oracle Discoverer Plus als Teil des IAS QCD steht allen Benutzern mit eingerichteten Zugriffsrechten zur Verfügung.
Geben Sie im Abschnitt „Arbeitsvorbereitung“ Folgendes an:
Für die Arbeit mit IAS QCD ist folgende Software erforderlich:
Bevor Sie mit der Arbeit mit IAS QCD am Arbeitsplatz des Benutzers beginnen, müssen Sie folgende Schritte durchführen:
Um die Verfügbarkeit des IAS QCD vom Arbeitsplatz des Benutzers aus zu prüfen, müssen Sie folgende Schritte durchführen:
Wenn die Oracle Discoverer Plus-Anwendung nicht startet, sollten Sie sich an den Support wenden.
Geben Sie im Abschnitt „Beschreibung der Vorgänge“ Folgendes an:
Geben Sie für jeden Datenverarbeitungsvorgang Folgendes an:
Oracle Discoverer Plus führt als Teil des IAS QCD die in der folgenden Tabelle aufgeführten Funktionen und Aufgaben aus:
Nachfolgend finden Sie eine Beschreibung der Benutzervorgänge zum Ausführen jeder Aufgabe.
Aufgabe: „Visualisierung der Berichterstattung“
Vorgang 1: Registrierung auf dem IAS QCD-Portal
Vorbereitende Schritte:
Auf dem Computer des Benutzers müssen zusätzliche Einstellungen gemäß Abschnitt 3.2 dieses Dokuments vorgenommen werden.
Letzte Schritte:
Nicht benötigt.
15-30 Sekunden.
Schritt 2: Wählen Sie einen Bericht aus
Bedingungen, unter denen die Operation durchgeführt werden kann:
Erfolgreiche Registrierung im IAS QCD Portal.
Vorbereitende Schritte:
Nicht benötigt.
Grundlegende Aktionen in der erforderlichen Reihenfolge:
1. Platzieren Sie im angezeigten Fenster „Assistent zum Erstellen von Arbeitsmappen“ einen Punkt neben dem Element „Vorhandene Arbeitsmappe öffnen“.
2. Wählen Sie die gewünschte Arbeitsmappe aus und klicken Sie auf die Schaltfläche „Öffnen“:
Letzte Schritte:
Nachdem Sie die Arbeit mit dem Bericht abgeschlossen haben, müssen Sie den Menüpunkt „Datei“ und dann den Punkt „Schließen“ auswählen.
Für den Betrieb aufgewendete Ressourcen:
15 Sekunden.
Aufgabe: „Erstellung tabellarischer und grafischer Berichtsformulare“
Ergänzen Sie analog.
Geben Sie im Abschnitt „Notfallsituationen“ Folgendes an: 1. Maßnahmen bei Nichteinhaltung der Bedingungen des technologischen Prozesses, einschließlich langfristiger Ausfälle technischer Geräte; 2. Maßnahmen zur Wiederherstellung von Programmen und/oder Daten im Falle eines Ausfalls magnetischer Datenträger oder der Entdeckung von Datenfehlern; 3. Maßnahmen bei Feststellung eines unbefugten Eingriffs in Daten; 4. Maßnahmen in anderen Notsituationen.
Sollten beim Betrieb des IAS QCD Fehler auftreten, die im Folgenden nicht in diesem Abschnitt beschrieben werden, müssen Sie sich an einen Mitarbeiter der technischen Supporteinheit des DIT (HelpDesk) oder den zuständigen Administrator des IAS QCD wenden.
Fehlerklasse | Fehler | Beschreibung des Fehlers | Erforderliche Benutzeraktionen, wenn ein Fehler auftritt |
---|---|---|---|
IAS QCD-Portal | Server nicht gefunden. Die Seite kann nicht angezeigt werden | Es kann zu Problemen mit dem Netzwerk oder dem Zugriff auf das IAS QCD-Portal kommen. | Um Netzwerkprobleme zu beheben, wenden Sie sich an einen Mitarbeiter des technischen Supports (HelpDesk). In anderen Fällen wenden Sie sich an den Administrator des IAS KHD. |
Fehler: Ein gültiger Benutzername ist erforderlich | Bei der Registrierung im IAS QCD-Portal wurde der Benutzername nicht angegeben. | Geben Sie Ihren Benutzernamen ein. | |
Fehler: Für die Registrierung ist ein Passwort erforderlich | Bei der Registrierung im IAS QCD-Portal wurde kein Passwort eingegeben. | Geben Sie Ihr Passwort ein. | |
Fehler: Authentifizierung fehlgeschlagen. Versuchen Sie es erneut | Der eingegebene Benutzername oder das Passwort ist falsch oder das Konto ist nicht registriert. | Sie müssen Ihren Benutzernamen und Ihr Passwort erneut eingeben, aber nach dem dritten erfolglosen Registrierungsversuch wird Ihr Konto gesperrt. Wenn Ihr Konto gesperrt ist, müssen Sie sich an den IAS KHD-Administrator wenden. | |
Stromausfall der Workstation | Die Workstation ist nicht mit Strom versorgt oder es ist ein Stromausfall aufgetreten. | Die Workstation wurde heruntergefahren oder neu gestartet. | - Drücken Sie die „Start“-Taste - Wählen Sie „Ausführen“ Versuchen Sie erneut, eine Verbindung (Anmeldung) zum IAS QCD herzustellen |
LAN-Fehler | Es gibt keine Netzwerkinteraktion zwischen der Workstation und dem IAS QCD-Anwendungsserver | Es besteht keine Möglichkeit, die Arbeit mit dem QCD IAS aufzunehmen (weiterzuführen). Es besteht keine Netzwerkverbindung zum IAS KHD-Server | Starten Sie die Workstation neu. Überprüfen Sie die Verfügbarkeit des IAS-KHD-Servers auf Port 80, indem Sie die folgenden Befehle ausführen: - Drücken Sie die „Start“-Taste - Wählen Sie „Ausführen“ - Geben Sie in der Eingabezeile den Befehl telnet ias_dwh.ru 80 ein - Wenn sich das Telnet-Fenster öffnet, ist die Verbindung möglich. Versuchen Sie nach der Wiederherstellung des lokalen Netzwerks erneut, eine Verbindung zum IAS QCD herzustellen (sich anzumelden). |
Kovtun M.V. Januar 2012.
In Verbindung stehende Artikel: | |
Eine einfache Möglichkeit, Kekse zu stehlen
Intercepter ist ein multifunktionales Networking-Tool, das... So installieren Sie Google-Dienste nach dem Flashen
Müssen wir Besitzern von Android-Geräten erklären, was... Das umwerfende Samsung Galaxy Z (2018) ist viel besser als jedes andere Smartphone der Welt
Lieferumfang Smartphone-Akku Li-Ion 2600 mAh Ladegerät... |