Керівництво в називанні незручних доменних об'єктів?

Я моделюю хімічну систему, і у мене виникають проблеми з називанням моїх елементів / предметів в межах enum.

Я не впевнений, чи варто використовувати:

• атомна формула
• хімічна назва
• скорочена хімічна назва.

Наприклад, сірчаною кислотою є H2SO4, а соляна кислота - HCl.

З цими двома, я, мабуть, просто використовую атомну формулу, оскільки вони досить поширені.

Однак у мене є інші, як гексафторсилікат натрію, який є Na2SiF6.

У цьому прикладі, атомна формула не настільки очевидна (для мене) , але хімічна назва потворно довго: myEnum.SodiumHexaFluoroSilicate. Я не впевнений, яким чином я міг би безпечно придумати скорочене хімічне ім’я, яке б мало послідовний зразок іменування.

Є кілька проблем, які я намагаюся вирішити, називаючи елементи enum.
Перший - читабельність, і довші назви представляють проблему.
Друге - це легкість підбору коду для нових технічних засобів, і тут більш короткі назви представляють проблему.
Наступне питання полягає в тому, що власники підприємств зазвичай посилаються на повну хімічну назву, але не завжди. "Ротові" хімічні речовини називають їх формулою.
Останнім питанням є забезпечення його послідовності. Я не хочу змішаної конвенції про іменування, оскільки буде неможливо запам'ятати, яку використовувати.

З точки зору технічного обслуговування, який із варіантів називання ви б хотіли бачити і чому?

Примітка: Все, що знаходиться нижче рядка, додаткове | уточнюючий матеріал. Будь ласка, не занурюйтесь у це. Основне питання стосується називання незручних об'єктів.

Атомний варіант

загальнодоступні myEnum.ChemTypes
{  
   H2SO4,
   HCl,
   Na2SiF6
}

Хімічна назва Варіант

загальнодоступні myEnum.ChemTypes
{
   Сірчана кислота,
   Хлористого-воднева кислота,
   Натрій гексафторосилікат натрію  
}

Ось кілька додаткових деталей із коментарів до цього питання:

• Аудиторію за кодом будуть просто програмісти, а не хіміки.
• Я використовую C #, але я вважаю, що це питання цікавіше при ігноруванні мови реалізації.
• Я починаю з 10 - 20 сполук і мав би щонайменше 100 сполук, тому мені не потрібно турбуватися про кожен можливий склад. На щастя, це фіксований домен.

• Перелік використовується як ключ для пошуку для полегшення загальних / загальних хімічних обчислень - це означає, що рівняння однакове для всіх сполук, але ви вставляєте властивість сполуки закінчувати рівняння.

  • Наприклад, Молярна маса (в г / моль) використовується при обчисленні кількості молей від маси (в грамах) сполуки. FWIW, Молярна маса == Молярна вага.
  • Іншим прикладом загального розрахунку є Закон про ідеальний газ та його використання Конкретної газової константи

Зразок функції може виглядати так:

публічний подвійний GetMolesFromMass (подвійний mass_gram, myEnum.ChemTypes chem)
{
  подвійний molarWeight = MolarWeightLookupFunctionByChem (хімічний); // повертає грам / моль
  подвійні молі = маса / молярна вага; // перетворюється на кротів

  зворотні родимки;
}

// Зразок виклику:
myMoles = GetMolesFromMass (1000, myEnum.ChemTypes.Na2SiF6);
// * або *
myMoles = GetMolesFromMass (1000, myEnum.ChemTypes.SodiumHexafluorosilicate);

публічний подвійний GetSpecificGravity (myEnum.ChemTypes chem, подвійний конц)
{
  // отримує питому вагу хімічної сполуки на основі концентрації
  подвійний sg = SpecificGravityLookupTableByChem (chem, conc);  
}

Отже, enum імені сполуки використовується як ключовий і для забезпечення узгодженості у посиланні сполуки на пов'язані функції.

Коли я почав переписувати свій сучасний проект зі спагетті в розумний код, я зіткнувся з тією ж проблемою. Мій проблемний домен - це медичні, а замість того, щоб використовувати такі імена, як "ETCO2" та "SPO2" для моїх переліків, я використав повні англійські імена.

З одного боку, було дуже корисно мати англійські імена, коли я був новаком у проблемній області. З іншого боку, зараз, коли я працюю з цими термінами рік, я вважаю, що повні англійські назви є занадто багатослівними, і я досить знайомий з термінами, які я б більше вважав за краще використовувати скорочення.

Моя порада полягає в тому, щоб використовувати атомну формулу і включити коментар до кожного значення enum, яке дає повне ім'я, за умови, що кожен, хто дивиться на ваш код, буде або а) хіміком, або b) працює над кодом досить довго що вони, природно, ознайомлюються з формулами.

Хто для аудиторії код? Чи будуть хіміки використовувати Enums чи просто програмістів без конкретного доменного навчання з хімії?

Якщо хіміки будуть використовувати код, запитайте їх. Дуже ймовірно, вони віддадуть перевагу скороченим символам, оскільки вони можуть легко розпізнати їх. Якщо програмісти загального знання будуть використовувати ці ідентифікатори від імені хіміків, я думаю, що краще перейти з англомовними версіями.

Немає причин не поєднувати "все вищезазначене".

Проблема з повними іменами полягає в тому, що це буде втомливо набирати, проблема з іменами символів - відсутність сенсу.

Отже, створіть константи значень з повним іменем. Потім створіть визначення, пов'язані з постійною. Потім ви можете легко створити новіші та короткіші визначення, коли ви ознайомитесь із значенням абревіатури.

const int SodiumHexaFluoroSilicate = 16893859;   
const float Gold = 196.966569;

#define SoduimSilicate SodiumHexaFluoroSilicate 
#define F6Na2Si SodiumHexaFluoroSilicate 
#define au Gold 

Створюючи будь-яку програму, слід відокремити дані від логіки програми. Чи справді хімічні сполуки є частиною логіки програми, а не даних, якими працює логіка програми?

Коли вони є даними, було б набагато краще не ставитися до них як до переліків, а краще читати їх імена та властивості з конфігураційного файлу та зберігати їх у структурі даних. Це також значно полегшить обслуговування. Коли потрібно додати нові сполуки або виявити помилку у властивостях одного, вони можуть просто відредагувати файл конфігурації.

Це здається, що його можна було б краще реалізувати як клас, який може розширюватись та перекладати, залежно від потреб розробників. Нижче наведено приклад C #, який я придумав, щоб дозволити декілька відомих визначених хімічних речовин (як властивості), а потім магазини, що піддаються пошуку (за допомогою Addта Getметодами). Ви також можете досить легко розширити, щоб мати молярну масу та інші хімічні властивості.

public interface IChemical
{
    string AtomicFormula
    {
        get;
    }

    string ChemicalName
    {
        get;
    }

    string AbbreviatedChemicalName
    {
        get;
    }
}

public sealed class Chemical : IChemical
{
    private static readonly IChemical h2so4 = new Chemical("H2SO4", "sulfuric acid", "sulf. acid");

    private static readonly IChemical hcl = new Chemical("HCl", "hydrochloric acid", "hydro. acid");

    private static readonly IDictionary<string, IChemical> chemicalsByAtomicFormula = new Dictionary<string, IChemical>();

    private static readonly IDictionary<string, IChemical> chemicalsByChemicalName = new Dictionary<string, IChemical>();

    private static readonly IDictionary<string, IChemical> chemicalsByAbbreviatedChemicalName = new Dictionary<string, IChemical>();

    private readonly string atomicFormula;

    private readonly string chemicalName;

    private readonly string abbreviatedChemicalName;

    static Chemical()
    {
        chemicalsByAtomicFormula.Add(h2so4.AtomicFormula, h2so4);
        chemicalsByChemicalName.Add(h2so4.ChemicalName, h2so4);
        chemicalsByAbbreviatedChemicalName.Add(h2so4.AbbreviatedChemicalName, h2so4);
        chemicalsByAtomicFormula.Add(hcl.AtomicFormula, hcl);
        chemicalsByChemicalName.Add(hcl.ChemicalName, hcl);
        chemicalsByAbbreviatedChemicalName.Add(hcl.AbbreviatedChemicalName, hcl);
    }

    public Chemical(string atomicFormula, string chemicalName, string abbreviatedChemicalName)
    {
        if (string.IsNullOrWhiteSpace(atomicFormula))
        {
            throw new ArgumentException("Atomic formula may not be null or whitespace.", "atomicFormula");
        }

        if (string.IsNullOrWhiteSpace(chemicalName))
        {
            throw new ArgumentException("Chemical name may not be null or whitespace.", "chemicalName");
        }

        if (string.IsNullOrWhiteSpace(abbreviatedChemicalName))
        {
            throw new ArgumentException("Abbreviated chemical name may not be null or whitespace.", "abbreviatedChemicalName");
        }

        this.atomicFormula = atomicFormula;
        this.chemicalName = chemicalName;
        this.abbreviatedChemicalName = abbreviatedChemicalName;
    }

    public static IChemical H2SO4
    {
        get
        {
            return h2so4;
        }
    }

    public static IChemical HCl
    {
        get
        {
            return hcl;
        }
    }

    public string AtomicFormula
    {
        get
        {
            return this.atomicFormula;
        }
    }

    public string ChemicalName
    {
        get
        {
            return this.chemicalName;
        }
    }

    public string AbbreviatedChemicalName
    {
        get
        {
            return this.abbreviatedChemicalName;
        }
    }

    public static void AddChemical(IChemical chemical)
    {
        if (chemical == null)
        {
            throw new ArgumentNullException("chemical", "chemical may not be null");
        }

        if (chemicalsByAtomicFormula.ContainsKey(chemical.AtomicFormula))
        {
            return;
        }

        chemicalsByAtomicFormula.Add(chemical.AtomicFormula, chemical);

        if (chemicalsByChemicalName.ContainsKey(chemical.ChemicalName))
        {
            return;
        }

        chemicalsByChemicalName.Add(chemical.ChemicalName, chemical);

        if (chemicalsByAbbreviatedChemicalName.ContainsKey(chemical.AbbreviatedChemicalName))
        {
            return;
        }

        chemicalsByAbbreviatedChemicalName.Add(chemical.AbbreviatedChemicalName, chemical);
    }

    public static IChemical GetChemicalByAtomicFormula(string atomicFormula)
    {
        if (string.IsNullOrWhiteSpace(atomicFormula))
        {
            throw new ArgumentException("Atomic formula may not be null or whitespace.", "atomicFormula");
        }

        IChemical chemical;

        return chemicalsByAtomicFormula.TryGetValue(atomicFormula, out chemical) ? chemical : null;
    }

    public static IChemical GetChemicalByChemicalName(string chemicalName)
    {
        if (string.IsNullOrWhiteSpace(chemicalName))
        {
            throw new ArgumentException("Chemical name may not be null or whitespace.", "chemicalName");
        }

        IChemical chemical;

        return chemicalsByChemicalName.TryGetValue(chemicalName, out chemical) ? chemical : null;
    }

    public static IChemical GetChemicalByAbbreviatedChemicalName(string abbreviatedChemicalName)
    {
        if (string.IsNullOrWhiteSpace(abbreviatedChemicalName))
        {
            throw new ArgumentException("Abbreviated chemical name may not be null or whitespace.", "abbreviatedChemicalName");
        }

        IChemical chemical;

        return chemicalsByAbbreviatedChemicalName.TryGetValue(abbreviatedChemicalName, out chemical) ? chemical : null;
    }
}

Ви можете додати нові хімічні речовини, такі як:

        Chemical.AddChemical(new Chemical("Na2SiF6", "sodium hexafluorosilicate", "sod. hex.flu.sil."));

і отримати інші біти як такі:

        Console.WriteLine(Chemical.GetChemicalByChemicalName("sulfuric acid").AtomicFormula);