I. Цел на настоящия документ


Документация на кода и коментари



страница6/7
Дата08.06.2017
Размер385.9 Kb.
#23135
1   2   3   4   5   6   7

2.8.Документация на кода и коментари


      • Какво е документация на кода? Какви видове документация на кода има?

      • Какво представляват коментарите в програмата? За какво се използват? Кога трябва да се използват?

      • Кога един фрагмент от кода трябва да се коментира и кога не?

      • Какви типове коментари съществуват?

      • Защо в кода не трябва да има закоментирани програмни фрагменти?

      • Какви са препоръките за правилно използване на коментарите в програмирането? Как се коментират отделни редове в програмата? Как се коментират отделни фрагменти от код в програмата? Как се коментират декларациите на променливите? Как се коментират конструкциите за управление?

      • Как се коментират процедурите, функциите и методите?

      • Как се коментират класовете, модулите и файловете на програмата?

      • Какво представляват стандартите за документация в стил JavaDoc в езици като Java и C#? Съответстват ли те на препоръките за правилно коментиране на кода и винаги ли трябва да се прилагат?

2.9.Код конвенции


      • Какво е представляват код конвенциите? Защо са необходими? Кога трябва да се използват? Има ли значение големината на проекта?

      • Какви типове правила включва една код конвенция?

      • Какво представляват конвенциите за имената на променливите, процедурите, функциите, методите, класовете и останалите елементи на програмата? Какво трябва да включва една такава конвенция?

      • Какво представляват конвенциите за документацията и коментарите? Какви правила и препоръки включва една такава конвенция?

      • Какво представляват конвенциите за форматиране на кода? Какви правила и препоръки включва една такава конвенция?

      • Какво представляват конвенциите за именоване на елементи (методи, променливи и т.н.) с подобно предназначение?

      • Какви други конвенции има в програмирането?

      • Трябва ли конвенциите за кода да включват и други правила, които насърчават писането на качествен програмен код? Трябва ли да се налагат на програмистите от една организация строги формални правила, които гарантират качеството на кода, или трябва да се търсят други механизми за контрол на качеството?

      • Конвенциите строги правила ли са или само препоръки? Може ли една конвенция да се спазва частично и влошава ли това качеството на кода?

      • Трябва ли конвенцията за кода да е неделима част от езика за програмиране или платформата? Има ли опити за такава интеграция? Добре ли ще е, ако компилаторите не компилират код, който не съответства на конвенцията, която е заложена в тях? Няма ли така да се наложи единствена за всички конвенция? Има ли полза от такава единствена конвенция?

2.10.Помощни средства и инструменти за конструиране на програмен код


      • Какво представляват помощните средства за конструиране на програмен код (programming tools)? Какви типове такива средства има? За какво служат? С какво помагат на програмиста?

      • Какво представляват инструментите за софтуерен дизайн? Какво представляват средствата за моделиране с UML и средствата за създаване на клас-диаграми?

      • Какво представляват средствата за работа със сорс-код? С какво те ни помагат? Какво включват добрите текстови редактори за сорс-код? Какво представляват инструментите за разглеждане и претърсване на сорс-код? Какво представляват анализаторите на сорс-код? Могат ли те да ни дадат конкретни съвети за качеството на кода и как успяват да открият потенциални проблеми в него? Какво представлява “Version Control” софтуерът и защо трябва задължително да се ползва при работа в екип?

      • Какво представляват средствата за създаване на сорс-код и изпълним код?

      • Какво представляват дебъгерите? Какви инструменти за тестване има? Какво може да се прави с тях? Какво е profiler?

      • Как програмистът може сам да създаде помощни средства за своята работа и защо понякога е необходимо?

      • Какво представляват интегрираните среди за разработка на софтуер (IDE – Integrated Development Environment)? Какво включват те? Защо се предпочитат пред отделните независими инструменти?

      • Какви други средства, подпомагащи писането на програмен код има? За какво служат и каква е ползата от тях?

3.Контрол над качеството на софтуера

3.1.Общи принципи


      • Какви са критериите за качество на софтуера от гледна точка на протребителя и от гледна точка на програмиста? В какво се различават гледните им точки?

      • В какво се състои процеса на контрол над качеството на софтуера? Какво включва този процес?

      • Как се изгражда концепция за тестване (testing concept)? Какво трябва да включва една такава концепция?

      • Защо е важно да се следи процеса на разработка?

      • Защо трябва да има въведени препоръки, насоки и конвенции? Каква е ползата от тях?

      • Защо е важно изготвянето и поддръжката на документация за проекта по време на разработката му?

      • Каква е ролята на review-тата в контрола на качеството на софтуера? Какво е дизайн review? Какво е code review?

      • Какво най-общо представлява процеса на тестване на софтуера и какви видове тестване включва?

      • Какво представлява процеса на откриване, систематизиране и отстраняване на дефектите?

      • Защо е необходима оценка на процеса на разработка (assessment)?

3.2.Code Reviews


      • Какво представляват код-ревютата (code reviews)? Каква е ролята им в процеса на осигуряване на качество на софтуера (software quality assurance)? Важни ли са те? Каква е ползата от тях? Кога трябва да се правят?

      • Какви типове код-ревюта има? Какво е характерно за тях?

      • Какво представлява формалната процедура, наречена “инспектиране на код” (inspections)? Какви са нейните основни принципи? Колко души взимат участие в една такава инспекция? Каква е ролята на всеки от тях? Как протича една инспекция? От какви стъпки се състои? Какво се случва на всяка от тези стъпки? Какви психологически фактори могат да указват влияние върху инспециите? Каква е ефективността на инспекциите?

      • Какво представлява процедурата наречена “walkthrough”? Какви са нейните основни принципи? Колко души обикновено взимат участие в една такава процедура? Каква е ефективността й?

      • Какво представлява процедурата наречена “четене на кода” (code reading)? Какви са нейните основни принципи? Каква е ефективността й?

      • Какви други типове формални ревюта има? Какво е характерно за тях? Каква е ефективността им?


Сподели с приятели:
1   2   3   4   5   6   7




©obuch.info 2024
отнасят до администрацията

    Начална страница