Ingineria Programarii: Documentarea Unui Proiect. Fisiere Help

Ingineria programãrii
Laboratorul 4
Documentarea unui proiect. Fiºiere help

1. Obiective
2. Crearea de fiºiere help
Florin Leon, Ingineria programarii - Laborator, http://florinleon.byethost24.com/lab_ip.htm

3. Activarea unui fiºier de help prin program
4. Generarea automatã a documentaþiei cu NDoc
5. Comentariile
6. Lucrul cu fiºiere: încãrcare, salvare
7. Aplicaþii
1. Obiective
Obiectivele principale ale laboratorului 4 sunt urmãtoarele:
 Crearea de fiºiere help în formatele HLP ºi CHM

 Activarea unui fiºier de help dintr-un program C#
 Generarea automatã a documentaþiei API a unei soluþii C# cu ajutorul utilitarului NDoc
În plus, ne propunem:
 Sã oferim o serie de recomandãri privind comentarea unui program

 Sã reamintim utilizarea dialogurilor de încãrcare ºi salvare, precum ºi o modalitate simplã de
a lucra cu fiºiere în C#
 Sã prezentãm ºi sã utilizãm o clasã care poate rezolva pãtrate magice de orice dimensiune
(atât de dimensiune imparã cât ºi de dimensiune parã).
2. Crearea de fiºiere help
2.1. Crearea de fiºiere HLP

Un utilitar gratuit pentru realizarea de fiºiere HLP este Microsoft Help Workshop. Acesta creeazã
fiºiere HLP pe baza unui document rtf (Rich Text Format), editat dupã anumite convenþii,
corespunzãtoare opþiunilor fiºierelor de help.
Subiectele din help sunt asociate în general cu un identificator unic. Acesta se insereazã printr-o
notã de subsol (footnote) cu caracterul „#”, înaintea titlului paginii respective. Deschiderea unei
anumite pagini de help, atât din fiºierul „cuprins”, cât ºi dintr-un program, se face pe baza acestui
identificator. Paginile sunt despãrþite cu „page break”.
Florin Leon, Ingineria programarii, http://florinleon.byethost24.com/lab_ip.htm

Fiºierul de help propriu-zis poate fi însoþit de un fiºier „cuprins”, cu formatul urmãtor:
:Base Exemplu.hlp
:Title Exemplu de fisier .hlp
:Index=Exemplu.hlp
1 Capitolul 1
2 Pagina 1=Topic_id1
1 Capitolul 2
„Base” reprezintã numele fiºerului de help, titlul determinã textul ce va apãrea pe bara ferestrei
help-ului, index-ul sugereazã fiºierul de unde se va face indexarea (în cazul nostru, acelaºi fiºier). În
continuare, se descrie structura help-ului într-o manierã arborescentã. Numerele din faþa
denumirilor de capitole reprezintã nivelul în arbore al subiectului respectiv:
Se observã cã legãtura la paginile corespunzãtoare se face pe baza identificatorului de subiect (topic id).

Pentru ca utilizatorul sã navigheze uºor prin help, sunt disponibile opþiuni de indexare ºi cautare a
cuvintelor cheie. În cazul indexului, cuvintele cheie sunt desemnate printr-o notã de subsol marcatã
„K”. Pagina de index afiºeazã lista cuvintelor cheie definite pentru fiecare subiect:

În pagina de cãutare „Find”, help-ul genereazã automat o listã cu toate cuvintele gãsite. Utilizatorul
poate introduce un anumit cuvânt (sau mai multe) ºi aflã în ce pagini apare acesta. Titlurile de
subiecte care apar în lista de jos sunt determinate de o notã de subsol marcatã „$” în fiºierul rtf.
Dacã se doreºte includerea unor imagini, acestea sunt pur ºi simplu inserate în fiºierul rtf ºi vor
apãrea în mod automat ºi în help.

O altã opþiune utilã este includerea de texte „pop-up”, în situaþii în care explicarea unui termen sau a
unui concept este suficient de scurtã ºi nu necesitã utilizarea unei pagini noi:

Acest format presupune inserarea unui text „ascuns” în fiºierul rtf. Dacã editorul folosit este
Microsotf Word, atunci trebuie sã activãm mai întâi opþiune de vizualizare a informaþiilor ascunse,
prin combinaþia de taste CTRL + * (sau CTRL+SHIFT+8). Textul „link” va fi subliniat ºi imediat
dupã el va fi introdus un identificator pentru fereastra micã ce va apãrea. Identificatorul va fi scris
cu litere ascunse, ceea ce se poate realiza din meniul Format → Font... → Hidden. Sã presupunem
cã identificatorul se numeºte POPUP.
Într-o altã paginã se va scrie textul care se doreºte sã aparã (în cazul nostru: Textul apare intr-o
fereastra mica). În faþa sa, va fi inseratã o notã de subsol marcatã „#”, iar conþinutul notei va fi
identificatorul menþionat anterior (POPUP).
Pentru realizarea unei legãturi la altã paginã, se va sublinia dublu textul corespunzãtor legãturii,
care va fi urmat de identificatorul subiectului paginii la care se vrea sã se sarã.

2.2. Crearea de fiºiere CHM
Un utilitar gratuit pentru realizarea de fiºiere CHM (Compiled HTML) este HTML Help Workshop:

Ideea care stã la baza acestui format este transformarea unui site web sau a unui grup de pagini html
într-un singur fiºier, cu opþiuni de navigare ºi cãutare.
Pentru a realiza un astfel de fiºier, trebuie create mai întâi paginile .html cu informaþiile utile. În
tab-page-ul Project se apasã al doilea buton din stânga, Add/Remove topic files. Este suficientã
includerea paginii de index, de la care se presupune cã existã legãturi cãtre celelalte pagini. Se
creeazã apoi câte un fiºier Contents ºi Index.
În tab-page-ul Contents, se pot insera subiectele corespunzãtoare unor anumite pagini. Pentru
aceasta se folosesc butoanele din stânga Insert a heading (un nod în arbore) ºi Insert a page (o
frunzã).

În mod analog se definesc ºi intrãri de index, care pot fi asociate cu una sau mai multe pagini:

Dacã o intrare de index are mai multe pagini asociate, la cãutare rezultatul va fi de forma:
Pentru generarea automatã a opþiunii de cãutare în lista de cuvinte a paginilor, se apasã primul
buton din stânga din tab-page-ul Project, numit Change project options, iar în pagina Compiler se
bifeazã cãsuþa Compile full-text search information.
3. Activarea unui fiºier de help prin program

3.1. Process.Start
Cel mai simplu mod de deschidere a unui fiºier help este printr-un apel la sistemul de operare. În C#
apelul este de forma:
System.Diagnostics.Process.Start("nume fiºier");

3.2. HelpProvider
C# mai conþine însã o clasã specializatã, numitã HelpProvider. Se introduce în formã un astfel de
obiect ºi apoi din fereastra de proprietãþi se seteazã numele fiºierului CHM asociat în câmpul
HelpNamespace. Desigur aceastã operaþie ºi cele descrise în continuare pot fi fãcute ºi prin
program. Apoi, pentru fiecare control din formã pentru care dorim sã aparã help atunci când apãsãm
tasta F1, trebuie sã modificãm urmãtoarele proprietãþi:

 Show help on help provider: true;
 Help navigator on help provider: locul unde vrem sã se deschidã help-ul: la pagina de
cuprins, la pagina de index, de cãutare sau la o paginã specificatã de programator;
 Help keyword on help provider: dacã pentru controlul respectiv avem o anumitã paginã care
trebuie deschisã, Help navigator on help provider va lua valoarea Topic iar în Help keyword
on help provider se va introduce calea cãtre pagina care trebuie deschisã, relativ la fiºierul
CHM. De exemplu, dacã fiºierul este obþinut prin compilarea unui director numit web, în
care se gãseºte un document pag1.htm, care trebuie deschis acum, în acest câmp se va
introduce: web\pag1.htm.
3.3. Help
O modalitate alternativã de activare a unui help CHM este prin folosirea clasei Help. Aceasta are
un numãr de metode statice specifice, precum ShowHelp, ShowHelpIndex, ShowPopup.
Pentru acelaºi exemplu de fiºier CHM vom avea:
Help.ShowHelp(this, "Exemplu.chm");
deschide fiºierul Exemplu.chm
Help.ShowHelp(this, "Exemplu.chm", "web/pag1.htm");

deschide pagina solicitatã din acelaºi fiºier
Help.ShowHelpIndex(this,"Exemplu.chm");
deschide pagina de index a fiºierului Exemplu.chm
Help.ShowPopup(this, "Pop-up window",

new Point(Cursor.Position.X, Cursor.Position.Y));
deschide o fereastrã de pop-up cu textul dorit la coordonatele curente ale mouse-ului
4. Generarea automatã a documentaþiei cu NDoc

NDoc genereazã documentaþie API pe baza assembly-urilor .NET ºi a fiºierelor de documentaþie
XML generate de compilatorul C#. NDoc poate genera documentaþia în diferite formate, precum
help-ul HTML în stil MSDN, CHM, formatul Visual Studio .NET (HTML Help 2), sau stilul de
pagini web de tip MSDN online.
Documentaþia XML se realizeazã automat prin includerea în codul sursã a comentariilor triple:
liniile care încep cu /// ºi care preced un tip definit de utilizator cum ar fi o clasã, un delegat sau o
interfaþã, un membru precum un câmp, eveniment, proprietate, metodã, sau un namespace.

Pentru a genera automat fiºierul XML, trebuie setatã calea cãtre acesta în Project Properties →
Build → Output → XML documentation file.

În programul NDoc, se adaugã assembly-ul pentru care se va crea documentaþia ºi se seteazã
proprietãþile proiectului – ce anume va fi inclus în documentaþie. De exemplu, un API pentru un
utilizator extern nu va documenta metodele private, acestea oricum nu vor putea fi accesate de
utilizator. Pentru a genera o referinþã de uz intern, se pot include ºi aceste metode prin setarea
proprietãþii respective.
Tot aici se alege titlul documentaþiei ºi formatul acesteia (Documentation type).
Apoi se apasã butonul Build Docs din bara de instrumente.

Va rezulta documentaþia în formatul ales.

5. Comentariile
Comentariile incorecte sunt mai dãunãtoare decât lipsa comentariilor – dezinformeazã ºi induc în
eroare cititorul. În cele ce urmeazã, se prezintã câþiva paºi de bazã pentru a îmbunãtãþi calitatea
comentariilor.
Trebuie sã se explice DE CE, nu CUM

Acesta este un punct cheie. Comentariile nu trebuie sã descrie cum lucreazã programul; se poate
vedea aceasta citind codul. Codul este descrierea definitivã a funcþionãrii programului, este bine sã
fi fost scris clar ºi inteligibil. Trebuie în schimb sã ne concentrãm asupra explicãrii motivelor pentru
care s-a scris în acest fel sau ce îndeplineºte în final un bloc de instrucþiuni. Trebuie verificat dacã
se scrie constant actualizarea structurii WidgetList din GlbWLRegistry sau
memorarea informaþiilor despre obiectele Widget pentru a fi folosite mai
târziu.
Cele douã formulãri sunt echivalente, dar a doua precizeazã scopul codului pe când prima spune
doar ce face codul. În timpul întreþinerii acelei pãrþi din cod, motivele pentru care aceasta existã se
vor schimba mult mai rar decât modalitãþile prin care se va realiza efectiv obiectivul. Întreþinerea
celui de-al doilea tip de comentarii este deci mult mai uºoarã. Comentariile bune explicã de ce, nu
cum. De asemenea, se poate folosi un comentariu peentru a explica alegerea unei anumite
implementãri. Dacã existã douã strategii de implementare posibile ºi se opteazã asupra uneia din
ele, atunci trebuie analizat dacã meritã sã se adauge un comentariu pentru a explica motivele
alegerii.

Nu trebuie descris codul
Comentariile descriptive inutile sunt evidente: ++i; // incrementeaza i. Unele pot sã fie
mult mai subtile: un comentariu descriptiv lung a unui algoritm complex, urmat de o implementare
a algoritmului. Nu este nevoie de a rescrie laborios codul în limbaj natural decât dacã se
documenteazã un algoritm complex care ar fi altfel impenetrabil. Apoi, trebuie sã ne îngrijoreze mai
mult rescrierea algoritmului decât a comentariului. Trebuie respectatã regula de aur: un fapt – o
sursã. Nu trebuie duplicat codul într-un comentariu.

Nu trebuie înlocuit codul
Dacã existã un comentariu care specificã ceva ce s-ar putea aplica prin însuºi limbajul de
programare (de exemplu aceastã variabilã ar trebui accesatã doar de cãtre
clasa A), atunci acest deziderat trebuie exprimat printr-o sintaxã concretã. Dacã ne gãsim în
situaþia în care scriem comentarii pentru a explica cum lucreazã un algoritm complex, atunci trebuie
sa ne oprim. Este bine sã documentãm codul, dar ar fi ºi mai bine dacã am putea face codul sau
algoritmul mai clar:
 Dacã se poate, codul trebuie împãrþit în câteva funcþii bine denumite pentru a reflecta logica
algoritmului;
 Nu trebuie scrise comentarii care sã descrie folosirea unei variabile; aceasta trebuie
redenumitã; comentariul care vrem sã-l scriem ne va spune deseori care ar trebui sã fie
numele variabilei;
 Dacã se documenteazã o condiþie care ar trebui sã fie întotdeauna îndeplinitã, poate ar trebui
sã se scrie o aserþiune de testare a unitãþilor (mai multe detalii se va vedea în laboratoarele
de testarea unitãþilor).
 Nu este nevoie de optimizãri premature care pot obscuriza codul.
Când ne aflãm în situaþia de a scrie comentarii dense pentru a explica codul, trebuie sa facem un pas
înapoi. Nu existã cumva o problemã mai mare care trebuie rezolvatã?
Codul neaºteptat trebuie documentat

Dacã oricare parte din cod este neobiºnuitã, neaºteptatã, sau surprinzãtoare, trebuie documentatã cu
un comentariu. Ne va fi mult mai uºor mai târziu când vom reveni, uitând totul despre problemã.
Dacã existã soluþii alternative specifice (work-arounds), acestea trebuie menþionate în comentarii.
Pe de altã parte, nu este nevoie sã fie documentat ceea ce este evident: codul nu trebuie repetat.
Comentariile trebuie sã fie clare

Comentariile folosesc pentru a adnota ºi explica codul. Acestea nu trebuie sa fie ambigue, ci din
contra, cât mai specifice. Dacã o persoanã citeºte comentariul ºi rãmâne sã se întrebe ce înseamnã,
atunci comentariul a scãzut calitatea programului ºi a afectat înþelegerea codului.
Comentariile ajutã la citirea codului

Comentariile sunt de obicei scrise deasupra codului pe care-l descriu, nu dedesubt. În acest fel,
codul sursã se citeºte în jos, aproape ca o carte. Comentariul ajutã la pregãtirea cititorului pentru
ceea ce urmeazã sã vinã. Folosite cu spaþii verticale, comentariile ajutã la împãrþirea codului în
„paragrafe”. Un comentariu introduce câteva linii, explicând ce se intenþioneazã sã se obþinã; codul
urmeazã imediat, apoi o linie goalã, apoi urmãtorul bloc. Existã o convenþie: un comentariu cu o
linie goalã înaintea lui apare ca un început de paragraf, în timp ce un comentariu intercalat între
douã linii de cod apare mai mult ca o propoziþie în paranteze sau o notã de subsol.
Comentariile din antetul fiºierului

Fiecare fiºier sursã ar trebui sã înceapã cu un bloc de comentarii ce descrie conþinutul sãu. Acesta
este doar o scurtã prezentare, o prefaþã, furnizând câteva informaþii esenþiale ce se doresc
întotdeauna afiºate de îndatã ce un fiºier este deschis. Dacã acest antet existã, atunci oricare
10

programator ce deschide fiºierul va avea încredere în conþinut; aratã cã fiºierul a fost creat cum
trebuie în pofida scrierii unui cod necomentat. Fiecãrui fiºier sursã îi trebuie comentatã
funcþionalitatea.
Unele persoane susþin cã antetul ar trebui sã furnizeze o listã cu toate funcþiile, clasele, variabilele
globale ºi aºa mai departe, care sunt definite în fiºier. Acesta este un dezastru pentru întreþinere; un
astfel de comentariu devene rapid învechit. Antetul fiºierului trebuie sã continã înformaþii despre
scopul fiºierului (de exemplu implementarea interfeþei IA) ºi o declaraþie cu drepturile de

autor care sã descrie proprietarul ºi regulile de copiere.
Antet-ul nu trebuie sã conþinã informaþii care ar putea deveni uºor învechite, precum data când a
fost ultima oarã modificat fiºierul. Aceasta probabil nu ar fi actualizatã des ºi ar induce în eroare.
De asemenea nu trebuie sã conþinã un istoric al fiºierului sursã care sã descrie toate modificãrile
fãcute. Dacã trebuie sã derulezi peste 10 pagini din istoricul modificarilor pentru a ajunge la prima
linie de cod, atunci devine incomod lucrul cu fiºierul. Din acest motiv, unii programatori pun o
astfel de listã la sfârºitul fiºierului, dar acesta va deveni nerezonabil de mare ºi se va încãrca mai
încet.
Degradarea comentariilor
Orice cod neîntreþinut corect tinde sã se degradeze, pierzând din calitatea proiectãrii originare.
Totuºi, comentariile tind sã se degradeze mult mai repede decât oricare altã parte de cod. Ele îºi
pierd sincronizarea cu codul pe care-l descriu ºi pot deveni profund supãrãtoare. Cea mai simplã
soluþie este aceasta: când se reparã, adaugã, sau modificã codul, se reparã, adaugã, sau modificã
orice comentariu din jurul sãu. Nu se modificã câteva linii ºi atât. Trebuie sã ne asigurãm cã orice
modificare din cod nu le va transforma în comentarii neadevãrate. Corolarul este urmãtorul: trebuie
sã creãm comentarii uºor de actualizat, dacã nu, ele nu vor fi actualizate. Comentariile trebuie sã fie
clar legate de secþiunea lor de cod ºi nu trebuie plasate în locaþii obscure.
6. Lucrul cu fiºiere: încãrcare, salvare

Clasele OpenFileDialog ºi SaveFileDialog afiºeazã dialoguri de încãrcare/salvare a fiºierelor. Aceste
obiecte trebuie apelate din alte componente, de exemplu un meniu sau un buton care, când vor fi
apãsate, vor determina apariþia ferestrei de dialog. În funcþia apelantã va trebui introdus un bloc de
tipul:
if (openFileDialog.ShowDialog() != DialogResult.OK) // nu s-a apãsat OK

return;
Metoda de mai sus determinã afiºarea dialogului. Dacã acesta se executã corect (utlizatorul a ales
un fiºier), este disponibilã proprietatea open/saveFileDialog.FileName, care conþine numele
fiºierului dorit (cale completã ºi nume).
Câteva proprietãþi:
 open/saveFileDialog.DefaultExt – extensia ataºatã în mod automat fiºierului;
 open/saveFileDialog.Filter – Dialogul de selecþie de fiºiere include un combobox
cu tipurile fiºierelor. Când utilizatorul alege un tip de fiºier din listã, numai fiºierele de tipul
selectat sunt afiºate în dialog. Filter poate fi setat în Properties sau în sursã, în formatul:
"Text files (*.txt)|*.txt";
 open/saveFileDialog.InitialDir – directorul implicit unde se deschide dialogul.
Poate fi de exemplu MyDocuments, dacã aceastã proprietate nu este specificatã. Pentru
directorul în care se aflã programul, se foloseºte „ . ”.
11

În continuare, se vor defini niºte stream-uri pentru fiºiere. De exemplu:
StreamReader sr = new StreamReader(openFileDialog.FileName);

// operaþii cu StreamReader-ul sr
// de exemplu scriem în fiºier un numãr n cu 3 zecimale
sr.WriteLine(string.Format("Numarul este {0:F3}", n));
sr.Close();
Pentru cu lucrul cu fiºiere trebuie inclus urmãtorul namespace:

using System.IO;
7. Aplicaþii
7.1. Realizaþi o interfaþã pentru desenarea unui pãtrat magic, cu ajutorul clasei MagicBuilder, din
arhiva laboratorului.
Indicaþii:
Un pãtrat magic este o matrice pãtraticã de dimensiune n, care conþine numerele întregi din
intervalul 1  n 2 ºi în care suma elementelor pe linii, coloane ºi diagonale este aceeaºi.
Pentru salvarea graficului, trebuie sã se foloseascã un obiect de tip Bitmap, care dispune de funcþii
de salvare/încãrcare a imaginilor. Deoarece obiectul Bitmap va fi folosit atât pentru desenarea
într-un PictureBox cât ºi pentru salvarea imaginii într-un eveniment de apãsare a unui buton, va
trebui sã avem un câmp în clasã, alocat în constructorul ferestrei:
private Bitmap _bmp;
public void MainForm()

{
InitializeComponent();
// in constructorul ferestrei, dupa metoda InitializeComponent();

_bmp = new Bitmap(pictureBox.Width, pictureBox.Height);
}
12

Desenarea în Bitmap trebuie pusã în legãturã cu suprafaþa de desenare a ferestrei din PictureBox.
Atunci, în evenimentul Paint al acesteia, vom avea o secvenþã de cod de forma:
Graphics g = Graphics.FromImage(_bmp);
// in continuare, desenarea se va face in g (in Bitmap)

g.Clear(Color.White);
...

// la sfârºit, vom desena continutul bitmap-ului in PictureBox
e.Graphics.DrawImage(_bmp, 0, 0);
Salvarea imaginii din Bitmap se va face desigur într-o altã metodã:
_bmp.Save(saveFileDialog.FileName, System.Drawing.Imaging.ImageFormat.Png);
Cu linia de cod de mai sus, imaginea va fi salvatã în format png.
7.2. Creaþi un fiºier HLP sau un fiºier CHM pentru programul Pãtratul magic.
Indicaþie: Cu ajutorul componentei HelpProvider se poate afiºa un help bazat pe context, de

exemplu pentru textbox-urile corespunzãtoare dimensiunii pãtratului ºi sumei caracteristice.
7.3. Creaþi o documentaþie API pentru clasa MagicBuilder folosind programul NDoc.
Comentariile triple trebuie introduse cu o linie mai sus de prima linie a clasei, câmpului sau metodei
comentate.
Exemple:
/// <summary>
/// Clasa pentru construirea unui patrat magic
/// </summary>
public class MagicBuilder
...
/// <summary>
/// Constructorul clasei pentru patratul magic
/// </summary>
/// <param name="size">Dimensiunea patratului</param>
public MagicBuilder(int size)
...
/// <summary>
/// Metoda care returneaza patratul construit
/// </summary>
/// <returns>Matricea corespunzatoare patratului magic</returns>
public int[,] BuildMagicSquare()
...
7.4. Opþional. Studiaþi programul de generare a unui antet cu informaþii pentru o sursã de program
(ProgramHeader.exe). Una din cerinþele proiectului este ca fiecare fiºier sursã sã aibã un astfel de
antet. Nu se cere implementarea unui astfel de program de generare.
13

Ingineria Programarii: Documentarea Unui Proiect. Fisiere Help

Încărcat de

Informații document

Titlu original

Drepturi de autor

Formate disponibile

Partajați acest document

Partajați sau inserați document

Opțiuni de partajare

Vi se pare util acest document?

Este necorespunzător acest conținut?

Drepturi de autor:

Formate disponibile

Ingineria Programarii: Documentarea Unui Proiect. Fisiere Help

Încărcat de

Drepturi de autor:

Formate disponibile

Ingineria programãrii

Documentarea unui proiect. Fiºiere help

Florin Leon, Ingineria programarii - Laborator, http://florinleon.byethost24.com/lab_ip.htm

 Crearea de fiºiere help în formatele HLP ºi CHM

 Sã oferim o serie de recomandãri privind comentarea unui program

2. Crearea de fiºiere help

2.1. Crearea de fiºiere HLP

Florin Leon, Ingineria programarii, http://florinleon.byethost24.com/lab_ip.htm

Florin Leon, Ingineria programarii, http://florinleon.byethost24.com/lab_ip.htm

Florin Leon, Ingineria programarii - Laborator, http://florinleon.byethost24.com/lab_ip.htm

Florin Leon, Ingineria programarii, http://florinleon.byethost24.com/lab_ip.htm

Florin Leon, Ingineria programarii - Laborator, http://florinleon.byethost24.com/lab_ip.htm

Florin Leon, Ingineria programarii, http://florinleon.byethost24.com/lab_ip.htm

Florin Leon, Ingineria programarii - Laborator, http://florinleon.byethost24.com/lab_ip.htm

Florin Leon, Ingineria programarii, http://florinleon.byethost24.com/lab_ip.htm

Florin Leon, Ingineria programarii - Laborator, http://florinleon.byethost24.com/lab_ip.htm

3. Activarea unui fiºier de help prin program

Florin Leon, Ingineria programarii, http://florinleon.byethost24.com/lab_ip.htm

Florin Leon, Ingineria programarii - Laborator, http://florinleon.byethost24.com/lab_ip.htm

Pentru acelaºi exemplu de fiºier CHM vom avea:

Help.ShowHelp(this, "Exemplu.chm", "web/pag1.htm");

Help.ShowPopup(this, "Pop-up window",

deschide o fereastrã de pop-up cu textul dorit la coordonatele curente ale mouse-ului

4. Generarea automatã a documentaþiei cu NDoc

Florin Leon, Ingineria programarii, http://florinleon.byethost24.com/lab_ip.htm

Florin Leon, Ingineria programarii - Laborator, http://florinleon.byethost24.com/lab_ip.htm

Tot aici se alege titlul documentaþiei ºi formatul acesteia (Documentation type).

Apoi se apasã butonul Build Docs din bara de instrumente.

Florin Leon, Ingineria programarii, http://florinleon.byethost24.com/lab_ip.htm

Florin Leon, Ingineria programarii - Laborator, http://florinleon.byethost24.com/lab_ip.htm

Trebuie sã se explice DE CE, nu CUM

Florin Leon, Ingineria programarii, http://florinleon.byethost24.com/lab_ip.htm

Florin Leon, Ingineria programarii - Laborator, http://florinleon.byethost24.com/lab_ip.htm

Codul neaºteptat trebuie documentat

Comentariile trebuie sã fie clare

Comentariile ajutã la citirea codului

Comentariile din antetul fiºierului

Florin Leon, Ingineria programarii, http://florinleon.byethost24.com/lab_ip.htm

Florin Leon, Ingineria programarii - Laborator, http://florinleon.byethost24.com/lab_ip.htm

6. Lucrul cu fiºiere: încãrcare, salvare

if (openFileDialog.ShowDialog() != DialogResult.OK) // nu s-a apãsat OK

Florin Leon, Ingineria programarii, http://florinleon.byethost24.com/lab_ip.htm

StreamReader sr = new StreamReader(openFileDialog.FileName);

Pentru cu lucrul cu fiºiere trebuie inclus urmãtorul namespace:

Florin Leon, Ingineria programarii - Laborator, http://florinleon.byethost24.com/lab_ip.htm

private Bitmap _bmp;

public void MainForm()

// in constructorul ferestrei, dupa metoda InitializeComponent();

Florin Leon, Ingineria programarii, http://florinleon.byethost24.com/lab_ip.htm

// in continuare, desenarea se va face in g (in Bitmap)

Florin Leon, Ingineria programarii - Laborator, http://florinleon.byethost24.com/lab_ip.htm

Salvarea imaginii din Bitmap se va face desigur într-o altã metodã:

Cu linia de cod de mai sus, imaginea va fi salvatã în format png.

Indicaþie: Cu ajutorul componentei HelpProvider se poate afiºa un help bazat pe context, de

Florin Leon, Ingineria programarii, http://florinleon.byethost24.com/lab_ip.htm

S-ar putea să vă placă și