Тренировка навыков быстрого программирования

[Old]

Часто это ничем особенным не грозит

Как правило любые ошибки в программах ничем особенным не грозят.

А вот скажем, если в enum находятся режимы работы, то его использование в качестве параметра, может избавить от проверки входных параметров.

[8Observer8]

Я имел ввиду, как понять без комментариев, что означает: errDataNoFormat. На самом деле, что это означает?

Лучше комментарии писать. А doxygen позволит сгенерировать документацию:

Код

C++ (Qt)
//! Коды ошибок
enum ErrorType {
    //! Нет ошибок
    errNone = 0,
 
    //! Ошибка открытия файла
    errFileOpen = -1000,
 
    //! Ошибка записи в файл
    errFileWrite = -1001,
 
    //! Некорректные данные в файле
    errDataBad = -5000
};
 

Всё же я соглашусь с OKTA, что нужно сразу возвращать, чтобы видно было, что программа дальше не будет выполняться:

Код

C++ (Qt)
int readData(const QString &fileName, QString &data ) {
    QFile iFile(fileName);
    if ( !iFile.open( QIODevice::ReadOnly ) ) {
        return ErrorType::errFileOpen;
    } else {
        data = iFile.readAll();
        iFile.close();
        return ErrorType::errNone;
    }
}
 

Код

C++ (Qt)
int showError(int errorCode, const char * fileName = 0);
int showError(int errorCode, const char * msg1 = 0, const char * msg2 = 0);
 

Здесь придется чуть повозиться (просто так fileName не напечатать), но возможностей больше. И, строго говоря, "Error: cannot open the file " не есть хорошо, строки-константы должны грузиться из ресурсов

Что значит просто так не напечатать? А как строку в ресурсах создать?

Код

C++ (Qt)
int showError(const QString & fileName, ErrorType errorCode) {
    switch (errorCode) {
    case ErrorType::errFileOpen:
        std::cerr << "Error: cannot open the file " << fileName.toStdString() << std::endl;
        break;
    case ErrorType::errFileWrite:
        std::cerr << "Error: cannot write to the file " << fileName.toStdString() << std::endl;
        break;
    case ErrorType::errDataBad:
        std::cerr << "Error: incorrect data in the file " << fileName.toStdString() << std::endl;
        break;
    default:
        std::cerr << "Error code: " << errorCode << "; file name: " << fileName.toStdString() << std::endl;
        break;
    }
 
    return errorCode;
}
 

[Old]

Всё же я соглашусь с OKTA, что нужно сразу возвращать, чтобы видно было, что праграмма дальше не будет выполняться:

Лучше после возврата не использовать else, это избыточно:

Код

C++ (Qt)
int readData(const QString &fileName, QString &data ) {
    QFile iFile(fileName);
    if ( !iFile.open( QIODevice::ReadOnly ) )
        return ErrorType::errFileOpen;
 
    data = iFile.readAll();
    return ErrorType::errNone;
}
 

[8Observer8]

Да, Вы правы! Спасибо!

[Old]

Да, Вы правы! Спасибо!

И как правило, в компаниях используется свой стиль обязательный к использованию, поэтому все рекомендации в этой тебе вам могут не пригодиться.

[8Observer8]

Сейчас вот так переписал:

Код

C++ (Qt)
//! Коды ошибок
enum ErrorType {
    //! Нет ошибок
    errNone = 0,
 
    //! Ошибка открытия файла
    errFileOpen = -1000,
 
    //! Ошибка записи в файл
    errFileWrite = -1001,
 
    //! Некорректные данные в файле
    errDataBad = -5000
};
 
ErrorType readData( const QString &fileName, QString &data );
ErrorType writeResult( const QString &fileName, QString &data );
void showData( const QString &data );
ErrorType showError( const QString &fileName, ErrorType errorCode );
 

[8Observer8]

Я думаю, что тут уже нечего усложнять Единственное, что... есть мысль сделать через исключения, но пока без них. Запись в файл:

Код

C++ (Qt)
/*!
 * Записываем данные в файл
 * \param fileName Имя файла, в который будем записывать
 * \param data Данные, которые будут записаны в файл
 * \return Код ошибки
 */
ErrorType writeResult( const QString &fileName, QString &data ) {
    QFile file(fileName);
 
    if ( !file.open( QIODevice::WriteOnly ) )
        return ErrorType::errFileOpen;
 
    QTextStream stream(&file);
    stream << data;
    file.close();
 
    if (stream.status() != QTextStream::Ok)
        return ErrorType::errFileWrite;
 
    return ErrorType::errNone;
}
 

[Igors]

Я имел ввиду, как понять без комментариев, что означает: errDataNoFormat. На самом деле, что это означает?

"Ошибка данные не форматированы"   Это я просто привел для примера. Как и предыдущая, начинается с errData, так что какое-то представление читающий сразу получает: ошибка в данных. Дальше (что за NoFormat) уже по задаче. А комментарии... полагаю скоро Вам надоест их рисовать

Код

C++ (Qt)
errDataBad,  // wrong (invalid) data

"Масло масляное", такой комментарий ничего не проясняет, он просто не нужен т.к. имя говорит само за себя.

И не надо строить наполеновских планов с Doxygen и.т.п. До этого еще дистанция такого огромного размера  

[Old]

И не надо строить наполеновских планов с Doxygen и.т.п. До этого еще дистанция такого огромного размера  

До чего "этого" эта дистанция?
Doxygen простой и удобный инструмент, который можно использовать всегда и везде, а не ждать программу своей жизни.

[8Observer8]

Следующий оператор if не выполняется в случае: (errorCode != 0). Почему?

Код

C++ (Qt)
//! Error codes
enum ErrorType {
    //! None errors
    errNone = 0,
 
    //! Error of the opening of a file
    errFileOpen = -1000,
 
    //! Error of the writing of a file
    errFileWrite = -1001,
 
    //! Wrong data
    errDataBad = -5000
};
 
int main( int argc, char *argv[] ) {
    // ...
    ErrorType errorCode = ErrorType::errNone;
 
    // Read data from a file
    QString iFileName = QString( "input.txt" );
    errorCode = readData( iFileName, data );
    if ( !errorCode ) {
        showError( iFileName, errorCode );
    }
 
    // ...
}
 

[Old]

Сейчас в примере написано: если нет ошибки (errorCode == 0), напечатать сообщение о ошибке.

Что значит не работает errorCode != 0?

[8Observer8]

Тело оператора if не выполняется в случае отсутствия файла:

Код

C++ (Qt)
if ( !errorCode ) {
    showError( iFileName, errorCode );
}
 

И ещё вопрос. У меня функция main() возвращает: return a.exec( );

Могу ли я так написать (то есть вернуть ErrorType::errFileOpen):

Код

C++ (Qt)
int main( int argc, char *argv[] ) {
    QCoreApplication a( argc, argv );
    // ...
 
    if ( errorCode != ErrorType::errNone ) {
        return showError( iFileName, errorCode );
    }
 
    // ...
 
    return a.exec( );
}
 

[Old]

Тело оператора if не выполняется в случае отсутствия файла:

Конечно, потому что оно будет выполняться при отсутствии ошибок (если errorCode == 0).

Могу ли я так написать (то есть вернуть ErrorType::errFileOpen):

Можете.

[8Observer8]

Закружился с этим выражением: !errorCode Понял. Спасибо!

Чтобы было понятнее, вот так написал:

Код

C++ (Qt)
if ( errorCode != ErrorType::errNone ) {
    return showError( iFileName, errorCode );
}
 

[OKTA]

Напиши просто if(errorCode) - читаться будет "если ошибка" грубо говоря, а if(!errorCode) - если не ошибка