[Down]     [26]    IPROJ mail Rástočný výber značiek - úloha       | IPROJ | [12.02.2017] |   FIIT Rastocny | Inteligentné spracovávanie textu
: Odpoveď - úloha http://www.svti.sk/IPROJ/FIIT/ --- NavrhZnaciek_V4.txt

http://www.svti.sk/IPROJ/FIIT/ :: Návrhy na postup - odpoveď Rast+Biel+Mora

http://www.svti.sk/IPROJ/FIIT/IPROJ_FIIT_MTF_12022017.pdf :: IPROJ_FIIT_MTF_12022017.pdf

: Karol Rástočný
Predmet: RE: Upresnujem cielovu a ideovu schemu pre VEGA, V4 - Horizont
Dátum: Fri, 10 Feb 2017 10:01:44 +0000
Komu: Stefan Svetsky
Kópia: "oliver.moravcik@stuba.sk" , "maria.bielikova@stuba.sk"



Dobrý deň,
V prílohe posielam dokument obsahujúci opis špeciálnych komentárov, používateľských značiek, zdrojovom kóde. Tieto značky používajú programátori na doplnenie nejakej informácie do kódu. Úplne prvou základnou úlohou je vedieť tieto značky z kódu získať a uložiť ich separátne tak aby sa dalo v nich vyhľadávať na základe:
- času ich vytvorenia
- autora
- ich typu
- atribútov
- adresovaných osôb
- mien súborov v ktorých sú uložené

Výsledkom vyhľadávania je identifikátor značky, súbor v ktorom sa nachádza a zoznam riadkov, ktoré sú označené značkou.

Na začiatok bude stačiť keď zvládnete túto úlohu. Ďalším pokračovaním bude ich aktualizácia - zmena pozície o úprave zdrojového kódu a zmena obsahu značky po jej úprave. K tejto úlohe vám v priebehu budúceho týždňa pripravím potrebné dáta.
Pekný deň,
Karol Rástočný

[d:\scan\]







[ZNACKA=CODEREVIEW] => // ZNACKA_ATRIBUT_subATRIBUT_

//CODEREVIEW_CRV_1subatribut

//CODEREVIEW_Category_18subatributov
//CODEREVIEW_Category_Documentation_


//CODEREVIEW_CVE_17podkategorii
CODEREVIEW_CVE_DoS_
CODEREVIEW_CVE_Overflow_





[d:\sv\iproj]
file:///d:\sv\iproj

... append from file:///d:\sv\iproj\NavrhZnaciek_V4.txt

Zoznam 8 znaciek XXXX a ich vlastností

Algoritmus: V prvom rade je treba vymyslieť, ako vkladať do tabuľky, aby to bolo možné
nazvať inteligentný systém na vyhľadávanie

=> ??? do kodf=XXXX, aby sa extrahovali (( ****** XXXX + počet zanov napr. 255)) do tabulky
=> mechanicky preniest do replace txtuni with "XXXX"+trim(txtuni)
a replace TP with "XXXX"+trim(tp)
=> tiedenie a vyklonovanie 8-mich. tabuliek s názvom napr. V4_TODO"sclustrovaných"
alebo do podadresára V4_XXXX a iba kódf = názov tabuľky
=> atribúty môžu byť vlastnosti = kod
(značenie napr. FIXME_?eTask alebo CODEREVIEW_?dCategory_ o Documentation )
=> kod1 cesty ofline a online
=> predmet=txtuni a kod2 poznámky rozširujúce predmet
=> TP
=> súbor = V4_XXXX

XXXX=
TODO
FIXME
NTH
TBD
SAMPLE
REVIEW
CODEREVIEW
REFACTOR



Zoznam znaciek a ich vlastností
TODO
Znacka urcujúca miesto v kóde, kde je potrebné doimplementovat nejakú úlohu.
Atribúty:
?eTask – ID úlohy z item tracking systému
FIXME
Oznacuje kód, v ktorom bola identifikovaná chyba. Špeciálny prípad Todo znacky.
Atribúty
?DTask – ID chyby z item tracking systému
NTH
Znacka urcujúca miesto v kóde, kde by bolo vhodné nieco dorobit. Táto práca ale nie je nevyhnutná.
TBD
Znacka urcujúca kód, ktorý je vo vývoji.
Atribúty:
?oTask – ID úlohy z item tracking systému
SAMPLE
Znacka vymedzujúca kód, ktorý je použitý ako príklad riešenia nejakého problému.
REVIEW
Oznacenie kódu, ktorý vyžaduje posúdenie skúsenejším vývojárom

CODEREVIEW_?dCategory_ o Documentation

CODEREVIEW
Oznacenie kódu, ktorý neprešiel posudzovaním
Atribúty:
?kCRV – id konvencie, ktoré bola porušená
?dCategory – Kategória pripomienky
o Documentation – dokumentácia; kód je nedostatocne zdokumentovaný
o Name – zlé pomenovanie; premennú/triedu/... je potrebné premenovat
o Threading – porušenie pravidiel práce s vláknami
o Test – ku kódu je potrebné doplnit testy
o Logging – chýbajúce/nevhodné zaznamenávanie udalostí
o Recommendation – odporúcanie na zlepšenie
o Configuration – konštanty by mali byt definované v konfiguracných súboroch
o Logic – chyba v logike riešenia/algoritmu
o Security – porušenie bezpecnostných pravidiel
o API – nevhodné použitie knižnice, služby, ...
o DataStructure – nevhodné použitie dátovej štruktúry
o ErrorHandling – porucenie pravidiel spracovania výnimiek a chýb
o Readability – zle citatelný kód. Napr. z dôvodu použitia príliš dlhých konštrukcií,
nevhodného formátovania, ...
o Style – všeobecné porušenie štýlu písania zdrojového kódu
o Async – zlé spracovanie asynchrónnych udalostí
o Scope – nevhodné použitie modifikátora prístupu
o Perf – možný problém s výkonnostou
?lCVE – typ zranitelnosti podla CVE (http://www.cvedetails.com). V prípade, že je známa konkrétna
zranitelnost, môže byt jej identifikátor uvedený v atribúte CRV
o DoS
o CodeExecution
o Overflow
o MemoryCorruption
o SqlInjection
o XSS
o DirectoryTraversal
o HttpResponseSplitting
o BypassSomething
o GainInformation
o GainPrivilegues
o CSRF
o FileInclusion
REFACTOR
Oznacenie kódu, ktorý vyžaduje refaktorovanie
Atribúty:
?SMetóda – metóda refaktorovania (podla: http://sourcemaking.com/refactoring), ktorá by mala
byt použitá
o Extract Method

 [Top]   <= Záznam z: C:\SV\Feb2017 * 07.03.2017 : 15:17:59