Další pokyny pro správu zdrojového kódu pro projekty a editory
Existuje řada pokynů, které by projekty a editory měly dodržovat, aby podporovaly správu zdrojového kódu.
Pokyny
Pokud chcete podporovat správu zdrojového kódu, měl by váš projekt nebo editor provést také toto:
| Plocha | Projekt | Editor | Detaily |
|---|---|---|---|
| Soukromé kopie souborů | X | Podpora prostředí soukromé kopie souborů. To znamená, že každá osoba zařazená do projektu má svou vlastní soukromou kopii souborů v daném projektu. | |
| Trvalost ANSI/Unicode | X | X | Pokud napíšete kód trvalosti, zachovají soubory ve formuláři ANSI, protože většina programů správy zdrojového kódu v současné době nepodporuje Unicode. |
| Vytvoření výčtu souborů | X | Projekt musí obsahovat konkrétní seznam všech souborů v něm a musí být schopen vytvořit výčet souborů pomocí IVsSccProject2 nebo GetProperty (VSH_PROPID_First_Child/Next_Sibling). Projekt by měl také prostřednictvím implementace GetMkDocument zveřejnit názvy položek a vyhledávání názvů podpory (včetně speciálních souborů) prostřednictvím své IsDocumentInProject implementace. | |
| Formát Text | X | X | Pokud je to možné, měly by být soubory v textovém formátu, aby podporovaly slučování různých verzí. Soubory, které nejsou v textovém formátu, nelze později sloučit s jinými verzemi souboru. Upřednostňovaný textový formát je XML. |
| Referenční dokumentace | X | Projekty založené na referencích jsou snadno podporovány ve správě zdrojového kódu. Projekty založené na adresářích jsou však podporovány také správou zdrojového kódu, pokud může projekt vytvořit seznam svých souborů na vyžádání bez ohledu na to, zda tyto soubory existují na disku. Při otevírání projektu ze správy zdrojového kódu se soubor projektu nejprve před libovolným z jeho souborů přenese. | |
| Zachování objektů a vlastností v předvídatelném pořadí | X | X | Zachovejte soubory v předvídatelném pořadí, například v abecedním pořadí, aby se usnadnilo sloučení. |
| Znovu načíst | X | X | Když se soubor na disku změní, musí být editor schopný ho znovu načíst. Když se účastníte správy zdrojového kódu, prostředí za vás znovu načte data voláním vaší ReloadDocData implementace. Nejobtížnější případ opětovného načtení je, když dojde k rezervaci, když jste volali IVsQueryEditQuerySave::QueryEditFiles a zpracovávají informace. V této situaci ale musí být možné znovu načíst kód. Prostředí automaticky znovu načte soubory projektu. Projekt však musí implementovat IVsPersistHierarchyItem2 , pokud má vnořené hierarchie, aby podporoval opětovné načítání vnořených souborů projektu. |