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

Но поскольку я снова и снова исследую библиотеку, мне действительно нужно понять, как следовал программист, и причины, лежащие в основе примененной стратегии.

Пример, который я сейчас изучаю, — это HMC5883L и то, как программист использовал библиотеку Wire для управления разработкой библиотеки. Опытным программистам это должно быть довольно легко, но я действительно изучаю концепции, стратегии и т. д.

Поскольку я говорю снова и снова, у меня возникают разные вопросы, поэтому, чтобы начать это обсуждение, я хочу начать с вопроса о программисте, пишущем две очень похожие функции, которые делают практически одно и то же.

// Читаем байт для регистрации
uint8_t HMC5883L::fastRegister8(uint8_t reg)
{
    uint8_t value;
    Wire.beginTransmission(HMC5883L_ADDRESS);
    #if ARDUINO >= 100
        Wire.write(reg);
    #else
        Wire.send(reg);
    #endif
    Wire.endTransmission();

    Wire.requestFrom(HMC5883L_ADDRESS, 1);
    #if ARDUINO >= 100
        value = Wire.read();
    #else
        value = Wire.receive();
    #endif
    Wire.endTransmission();

    return value;
}

// Читаем байт из регистра
uint8_t HMC5883L::readRegister8(uint8_t reg)
{
    uint8_t value;
    Wire.beginTransmission(HMC5883L_ADDRESS);
    #if ARDUINO >= 100
        Wire.write(reg);
    #else
        Wire.send(reg);
    #endif
    Wire.endTransmission();

    Wire.beginTransmission(HMC5883L_ADDRESS);
    Wire.requestFrom(HMC5883L_ADDRESS, 1);
    while(!Wire.available()) {};
    #if ARDUINO >= 100
        value = Wire.read();
    #else
        value = Wire.receive();
    #endif
    Wire.endTransmission();

    return value;
}

Обновление: Собственно, первую версию программист использовал только в функции HMC5883L.begin();, но почему?

if ((fastRegister8(HMC5883L_REG_IDENT_A) != 0x48)
|| (fastRegister8(HMC5883L_REG_IDENT_B) != 0x34)
|| (fastRegister8(HMC5883L_REG_IDENT_C) != 0x33))
{
return false;
}

Все остальное в библиотеке использовало вторую версию.

Итак, по сути, эти две функции предназначены для чтения указанного регистра в HMC5883L, мои вопросы:

1. в чем разница? Я знаю, что второй функции было уделено особое внимание, но почему?
2. Это так важно?
3. Есть ли ситуации, требующие какой-либо версии функций?