G4例子學習文檔工具doxygen的使用

2021-03-02 Geant4模擬學習交流

上一篇文章講了兩個工具的使用，其中一個git，是管理代碼必備的，而markdown則未必一定要用，對於G4，很多代碼並沒有提供.md結尾的markdown語法的readme說明文檔，這一點上次沒有說清楚，以為所有的例子都有markdown的說明文檔，這裡道個歉，而G4所有例子的源碼都提供了符合doxygen語法的readme說明文檔格式。這樣的文檔裡面大量的語法標記，顯然不利於閱讀。由於例子代碼的根目錄內置了doxygen配置文件和shell腳本，Linux下可以很方便的使用shell腳本進行文檔的生成。如果你的電腦是聯網的,自己做後續這些意義不大,因為有官網做好的。如下圖

下面是針對不聯網的電腦進行的操作,當然聯網電腦作為個人學習也是可以繼續閱讀的。那麼，怎樣在windows下將這些例子源碼文檔生成，達到更便於閱讀和學習的目的呢？步驟如下：

 

1、下載doxygen-1.8.13-setup.exe並安裝doxygen

 

我的是以前下載的，所以用的1.8.11版本，其實差別還是不大的。

2、配置並運行生成文檔

生成文檔的過程如下

下圖表明文檔生成完畢

生成的文檔目錄如下

進入html目錄，首先打開的目錄叫做index.html，當然，生成的文檔可以託管到在線網站裡面或者本地網站裡面。那樣打開Ip地址或者域名就能自動打開index.html

3、打開html文檔如下

可以看到每個例子的源碼都已經生成了doxygen網站

 

下次有機會再分享LXR網站的生成，其介紹的截圖如下

 

而G4網站上的LXR工具則如下圖

 

 

相關焦點

  • Doxygen入門簡明教程(Windows)
    1 Doxygen是什麼Doxygen是一個基於原始碼的文檔自動生成工具，可以將程序中的特定格式的注釋轉換成說明文檔或者API參考手冊，從而減少軟體開發人員整理文檔的時間
  • 如何在PDF文檔中使用畫圖工具?
    PDF文檔的標註有很多種類型，比如矩形、橢圓形等。那麼如何在PDF文件中添加不同形狀的注釋呢?這是讓很多小夥伴犯難的問題。下面以極速PDF編輯器的操作為例詳細。首先用極速PDF編輯器打開PDF文檔後，在軟體頁面左下角導航欄可看到很多畫圖工具；可點擊底部導航欄圖標按鈕使用畫圖工具，可添加圖形標記和文本信息：在 PDF 文檔中可繪製箭頭、線條、矩形、橢圓等。
  • 騰訊文檔網絡填表，便捷好用的遠程的工具
    為了解決這個問題，我想起了騰訊文檔這個馬家工具。如果有一份表格需要和不同的學員核實填寫，應該怎麼做呢？我相信相關部門已制定好了這個電腦文檔，那麼現在只需要將這個文檔上傳到騰訊文檔，然後另存為一份命名為學員名字＋文件名，將這個文檔分享給對應學員。該位學員就能夠，在線填好這個表格。而部門那邊也能夠實時看到這個表格填寫的情況。
  • 西班牙語學習工具RAE的使用
    今天給大家介紹一個西語學習的進階神器——RAE食用指南：本推送適用於西語專業大二上學期以上及歐洲語言共同參考框架B1水平以上的同學。還沒有到這個階段的同學可以先收藏本文留待後用。在RAE官網上有在線網頁版，在AppStore上也有在線版（需聯網使用），都是免費的。RAE的官方網址為 www.rae.es 它凝結了西語世界傑出的語言學家們百年來的智慧，是我們窮盡一生都學習不完的知識寶庫，下面介紹幾個RAE的簡單用法：在官網右上角有詞典選項。最常用的就是DRAE，我們可以選擇之後進行查詢。
  • 工具 | 5款在線文檔寫作&協作工具
    office/WPS完成自己負責部分，在統一整理到一個文檔上，這種方法不僅耗時耗力，還極容易出錯今天給大家推薦幾款新媒體運營中常用的 在線文檔協作工具，有了它，今後可以多人共同編輯一份文檔，設置查閱/編輯權限，接口不變數據實時更改
  • ABBYY PDF Transformer+ PDF文檔轉換工具
    轉換器+ 結合智能技術和易於使用的界面,為您提供方便的瀏覽工具供使用任何類型和複雜的PDF文檔。享受直觀導航使用直觀的導航工具方便地瀏覽PDF內容。您可以在頁與頁之間快速跳轉；使用「適合寬度」選項放大或縮小。審閱和評價分享!泰比（ABBYY）PDF Transformer的兼容性意味著你可以輕鬆分享或者接收任何PDF類型的評論，註解。方便的工具,使簡單的回顧pdf文檔添加評論和注釋,突出顯示的文本和討論狀態。
  • 在線Word文檔怎麼做—使用超級文檔一站式解決
    超級文檔 | 下一代在線多人協作Word | sdocapp.com在2020 年的今天，大部分企業團隊都已經轉而使用在線 word，而超級文檔是一個免費的以在線文檔為核心的協作辦公工具，在完整的排版和格式支持之外，還可以在文檔中嵌入任務看板、思維導圖、表格、表單、投票等等提高辦公效率的功能。
  • 告別手寫 API文檔生成工具推薦
    隨著API的發展以及需求的日益增加，對API文本文檔的需求與隨之而來。相信許多開發人員都遇到過編寫API文檔方面的問題及煩惱。你是否還通過手寫的方式來生成和編寫這些文檔呢？那麼你就OUT啦！話說工欲善其事必先利其器，本文分享8款非常好的API文檔生成工具給大家。
  • 如何使用EverEdit工具對文檔內容進行AES加密和解密方式操作處理
    我們大家在編輯整理一些文檔素材時，為了安全起見，可能需要對文檔內容進行加解密處理。本期小編要介紹的文章是如何使用EverEdit工具對文檔內容進行AES加密和解密方式操作處理的演示步驟，希望能對大家有所幫助。
  • Angular 2官方文檔導讀
    全新手自學如果你是個沒有前後端開發經驗的全新手，而且是自學，那麼你需要學的東西確實很多。不過別著急，先為自己定個小目標，比如，先把別人的範例程序跑起來。如果你能翻牆，那就不需要在本地準備任何環境，只要點文檔中的任何「live example/在線例子」的連結就可以了，你可以進去修改代碼，並且預覽效果。
  • TensorRT使用文檔--Overview
    TensorRT下載地址：https://developer.nvidia.com/nvidia-tensorrt-downloadTesnsoRT介紹文檔：https://devblogs.nvidia.com/tensorrt-3-faster-tensorflow-inference/TensorRT開發者指南：http://docs.nvidia.com
  • 評職稱必須要g4論文嗎
    評職稱必須要g4論文嗎?g4是刊物類型編碼，所謂g4論文就是在編號g4的期刊上發表的論文，那麼g4代表什麼刊物呢?g所代表的大類是文化、科學、教育、體育，g4代表的就是其中的教育類期刊，評職稱是否需要發表g4期刊論文要看作者是否是教育工作者，只要是教育工作者都是適合發表g4期刊的。
  • 二代i5-2140獨顯 惠普G4 1017僅4999
    惠普近期推出了惠普g4-1017TX機型。該筆記本採用了酷睿新二代i5處理器，並且配備了性能強大的獨立顯卡。如此主流實用的配置目前商家報價4999元，喜歡惠普的朋友們請關注了。內飾方面，惠普g4-1017TX筆記本使用了14英寸惠普專利技術的BrightViewLED液晶屏，內置LED背光源。給用戶帶來美輪美奐的逼真畫面。巧克力式的鍵盤、寬敞的掌託與觸控面板，有效防止使用者操作上的失誤。
  • smart-doc 1.8.1 發布,Java 零註解文檔生成工具
    smart-doc是一個java restful api文檔生成工具， smart-doc完全基於接口源碼分析來生成接口文檔，完全做到零註解侵入
  • 最好用的文檔協作工具有哪些?這5款推薦給你!
    要想提升新媒體運營的效率，選擇合適的工具也是必不可少的一部分。尤其在文案寫作的過程中，有的時候需要跟團隊協同合作，對一篇文章進行校對和修改，就需要用到文檔協作工具。下面就為大家帶來五款超好用的文檔協作工具，提高工作效率。
  • smart-doc 1.9.9 發布,Java 零註解 API 文檔生成工具
    smart-doc完全基於接口源碼分析來生成接口文檔，完全做到零註解侵入，你只需要按照java標準注釋編寫，smart-doc就能幫你生成一個簡易明了的markdown 或是一個像GitBook樣式的靜態html文檔。如果你已經厭倦了swagger等文檔工具的無數註解和強侵入汙染，那請擁抱smart-doc吧！
  • 用5個工具下N篇文檔，徹底解決全網付費文檔下載難題
    因此早都在 2 年前就給大家介紹過冰點下載器，後來還介紹過一個同類型的大聖文庫下載器（現在已不能正常使用）。除此之外，市面上其實還有其它類似的下載文庫網站的資料工具。所以這篇不只是安利工具，更重要的是以解決問題為出發點，力求讓這篇文章能夠幫你解決下載文檔的難題。
  • 使用 Sphinx 將個人筆記變成文檔的形狀~
    本文從記錄筆記和後期歸檔出發，對比了多個平臺記錄筆記的特點和優勢，最後詳細記錄了使用 Sphinx 編譯筆記為 html 的例子。
  • smart-doc 1.9.4 發布,Java 零註解 API 文檔生成工具
    smart-doc完全基於接口源碼分析來生成接口文檔，完全做到零註解侵入，你只需要按照java標準注釋編寫，smart-doc就能幫你生成一個簡易明了的markdown 或是一個像GitBook樣式的靜態html文檔。如果你已經厭倦了swagger等文檔工具的無數註解和強侵入汙染，那請擁抱smart-doc吧！