LINUX.ORG.RU

Почему на специальности, связанных с программированием не обучают разрабатывать документацию?


2

1

С этим возникают очень серьезные проблемы. На мой взгляд, кроме разработки собственно заказного ПО, программист должен уметь разработать полный комплект документации в соответствии с ГОСТ и требованиям ПЗ.


Ответ на: комментарий от Iron_Bug

вообще, код должен соответствовать комментариям. иначе смысл комментариев?

Вообще-то если он полностью соответствует, то комментарии и не нужны — и так всё ясно. А вот когда вроде всё работает (все тесты проходит), но спецификация достаточно мутная, то лучше написать комментарий про то, что именно пытались изобразить.

Например (из драйвера NVidia)

// TODO: This would be easier if RM allowed for multiple registrations, since we
//       could register UVM-Lite and UVM-Next separately (bug 1372835).
static RM_STATUS uvm_gpu_event_start_device(UvmGpuUuid *gpuUuidStruct)
{
    RM_STATUS rmStatus;

    if (uvmlite_enabled())
    {
        rmStatus = uvmlite_gpu_event_start_device(gpuUuidStruct);
        if (rmStatus != RM_OK)
            return rmStatus;
    }

    if (uvmnext_enabled())
    {
        rmStatus = uvmnext_gpu_event_start_device(gpuUuidStruct);
        if (rmStatus != RM_OK)
        {
            // Take UVM-Lite back down if UVM-Next failed to start
            if (uvmlite_enabled())
                uvmlite_gpu_event_stop_device(gpuUuidStruct);
            return rmStatus;
...

Или при разработке компилятора лучше втыкать цитаты из стандарта, чтобы было понятно, что именно код пытается сделать.

так что наша рашиянская бухгалтерия, увы, в отличие от R3 (и прочих R-ов) навсегда обречена на говнокод

В R3 говнокода при разработке управленческих (то есть под конкретного заказчика) отчётов гораздо больше. Потому что после десятого «уточнения» со стороны заказчика, чего именно он хотел код уже почти нечитаем. А хотелок в R3 обычно гораздо больше, так как раз уж раскошеливаться, то «система должна делать всё». С бухгалтерским законодательством как раз проще (оно меняется не чаще раза в квартал, можно успеть переписать).

monk ★★★★★
()
Ответ на: комментарий от anonymous

профессор Шалыто в своё время провозглашал движение за открытую проектную документацию

http://www.osp.ru/pcworld/2003/09/166401/

но я не знаю, вылилось ли это во что-то крупное...

hobbit ★★★★★
()

Воронежский Государственный Технический Университет (бывший ВПИ). Специальность «Вычислительные машины, комплексы, системы и сети».

Документацию составлять учили. Я правда уже почти ничего не помню, т.к. не программист, но какие-то обрывки в памяти всплывают иногда =).

elve
()
Вы не можете добавлять комментарии в эту тему. Тема перемещена в архив.