Giter VIP home page Giter VIP logo

testlab3's Introduction

TestLab3

This is lab work about documentation

Check list:

Порядок выполнения лабораторной работы #3

Checked 1. Выбрать проект, в котором есть хотя бы несколько классов, хотя бы два уровня иерархии ООП.

Checked 2. Залить его в репозиторий, в папку QA_Lab3_Surname с вашей фамилией. Ссылку на папку в Гитхабе поместить в отчет.

Checked 3. Выбрать фреймворк для генерации документации, в зависимости от языка программирования, на котором написан ваш проект. Я предлагаю использовать Doxygen, он поддерживает много языков, но можете выбрать и что-то другое, например JSDoc для JavaScript, DocFx для .NET, JavaDoc для Java.

Checked 4. Написать документирующие комментарии (https://habr.com/ru/post/252101/) к каждому классу, к каждому публичному методу. Добавить хотя бы одну картинку, одну формулу, и один любой граф (https://habr.com/ru/post/253223/).

Checked 5. Написать обычные поясняющие комментарии (https://habr.com/ru/company/vk/blog/354892/), если это необходимо в соответствии с рекомендациями.

Checked 6. Сгенерировать HTML страницы. Скриншоты сгенерированного портала документации поместить в документ с отчетом.

Checked 7. Залить отчет в LMS.

testlab3's People

Contributors

foxblackred avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.