C++ kodunu belgelemek için Doxygen kullanıyorum ve kod için önemli miktarda Doxygen dokümanı yazıyorum. Bir yerde ben kodunda grupların bir listesini yapıyorum ve şöyle görünmesini istiyorum:Referansın sonu nasıl?
- Control Module: her şeyi
- Slave Module kontrol modülü: köledir modül Control Module
Benim belgeleme kaynak şöyle görünür:
- @ref CM: Her şey
kontrol modülü - SM @ref: @CM
Ama kölesidir modül sorun: Doxygen CM: olarak referans adını okuma gibi görünüyor, CM değil ve bu nedenle referansı bulamıyor. Yani, bir şekilde referans ismin bittiği yer olan Doxygen'e söylemem gerek. (Örneğin, Bash'i kullanıyordum ve bir "s" ile bir değişken dizeyi bir sonek olarak çağırmak isteseydim, echo "${NOUN}s" kullanırdım.)
Bir geçici çözüm olarak, ad ile boşluk arasında boşluk ekleyebilirim. Sonraki kolon, ancak sonuçta ortaya çıkan dokümanı okumayı zorlaştırır ve bundan kaçınmak isterim.
Special Commands altında Doxygen manuel aşağıdaki umutlu sondaj bilgileri içerir:
Bazı komutları bir veya birden fazla argüman var. Her bir bağımsız değişken belirli alanı vardır:
- > keskin < ise parantez argümanı bir kelime kullanılır.
- Eğer (yuvarlak) parantez kullanılırsa, argüman, komutun bulunduğu satırının sonuna kadar devam eder.
- {curly} diş telleri kullanılırsa argümanı bir sonraki paragrafa kadar devam eder. Paragraflar boş bir hattı veya bir bölüm göstergesi tarafından sınırlandırılır. , bu destekler gitmek gerekiyor
Tamam, bu iyi ve iyi, hepsi ama dokümantasyon söylemez, ben çözemiyorum. Tek başına argümanın etrafında mı? Bütün komuta ve argüman etrafında mı? Ne işe yarıyor, ne de işe yarayan bir alternatifle gelemiyorum.
Peki, bir referans adının sonunu Doxygen'e nasıl bildirebilirim? Ve parantez cevap ise, nereye giderler? Eğer alıntı
Köşeli ayraçlar, sınırlayıcı olarak değil, notasyonel düzenler içindir. Sınırlayıcı, beyaz boşluk/yeni satırdır. Soru her zaman bir "isim" nin sınırlayıcı/sonu olarak kullanılacak. – albert