Bağlantı noktalarınız için kullanım belgeleri sağlayın

  • Makale

Genel bakış

Bağlantı noktaları için kullanım belgeleri sağlamak, kullanıcıların projelerinde bunları kolayca benimsemesini sağlar. Bağlantı noktasının dizininde (ports/<port name>/usage) bir derleme sistemiyle tümleştirmek için gereken en düşük adımları açıklayan bir usage dosya sağlamayı kesinlikle öneririz.

Kullanım dosyası sağlama

Kullanım belgeleri sağlamak için bağlantı noktasının share yükleme dizininde adlı usage bir metin dosyası oluşturun. Önerilen yöntem içinde işlevini portfile.cmakeçağırmaktırconfigure_file().

Örneğin:

configure_file("${CMAKE_CURRENT_LIST_DIR}/usage" "${CURRENT_PACKAGES_DIR}/share/${PORT}/usage" COPYONLY)

Bağlantı noktalarını yükledikten sonra vcpkg, 'a ${CURRENT_PACKAGES_DIR}/share/${PORT}/usage yüklenen dosyaları algılar ve kullanım yönergelerini yazdırır.

İçerik biçimi

Paketin nasıl kullanılacağına ilişkin net yönergeler sağlayın. İçerik kısa, iyi yapılandırılmış olmalı ve kitaplığı kullanmak için gereken en düşük derleme sistemi tümleştirmesini vurgulamalıdır.

Paketi etkili bir şekilde kullanma konusunda net ve net olun. Kod parçacıkları, komut satırı yönergeleri veya yapılandırma ayrıntılarıyla kullanıcıları bunaltmaktan kaçının. Bunun yerine, kullanıcıların kitaplığınız hakkında daha fazla bilgi edinebilmesi için bağlantı noktasının dosyasındaki özelliğini kullanın."documentation"vcpkg.json

Dosyalarınız usage için desen olarak aşağıdaki şablonları kullanın:

CMake hedefleri olan paketler:

<port> provides CMake targets:

    <instructions>

Yalnızca üst bilgi kitaplıkları:

<port> is header-only and can be used from CMake via:

    <instructions>

Dosya örneği usage

proj provides CMake targets:

    find_package(PROJ CONFIG REQUIRED)
    target_link_libraries(main PRIVATE PROJ::proj)