亚洲免费av电影一区二区三区,日韩爱爱视频,51精品视频一区二区三区,91视频爱爱,日韩欧美在线播放视频,中文字幕少妇AV,亚洲电影中文字幕,久久久久亚洲av成人网址,久久综合视频网站,国产在线不卡免费播放

        ?

        使用開源軟件自動生成API文檔

        2020-12-23 07:17:54董洪蒙
        錦繡·中旬刊 2020年12期
        關(guān)鍵詞:開發(fā)人員開發(fā)者開源

        董洪蒙

        摘要:軟件開發(fā)者一項(xiàng)重要的工作就是文檔的編寫,但這是一項(xiàng)枯燥泛味的工作,大多數(shù)軟件開發(fā)者只專心于代碼的編寫,后期的文檔不善于編寫,造成團(tuán)隊(duì)開發(fā)的一些困擾。如果在程序代碼開發(fā)階段中就能實(shí)現(xiàn)文檔的編寫,無疑是一舉兩得的事情。本文探討了如何使用國產(chǎn)優(yōu)秀的開源軟件ShowDoc自動通過程序代碼注釋進(jìn)行文檔的自動生成,為前后端開發(fā)者提供了編寫文檔的捷徑,共同發(fā)展提高。

        關(guān)鍵詞:ShowDoc,程序文檔

        作為軟件開發(fā)者,文檔的編寫整理是一項(xiàng)十分重要的工作。開發(fā)人員都很希望別人能寫技術(shù)文檔,而自己卻很不希望要寫文檔。因?yàn)閷懳臋n需要花大量的時間去處理格式排版,想著新建的word文檔放在哪個目錄等各種非技術(shù)細(xì)節(jié)。word文檔零零散散地放在團(tuán)隊(duì)不同人那里,需要文檔的人要花費(fèi)大量時間進(jìn)行溝通,通過QQ、郵箱接收對方的文檔。這種溝通方式當(dāng)然可以,只是效率不高。

        ShowDoc就是一個非常適合軟件開發(fā)團(tuán)隊(duì)的在線文檔分享工具,它可以加快團(tuán)隊(duì)之間溝通的效率,并且有著精巧的設(shè)計(jì),可以通過程序編寫過程中十分便利地順手寫的程序注釋,自動形成規(guī)范的文檔,貼近于開發(fā)人員的使用習(xí)慣,是非常優(yōu)秀的開源工具。

        下面本人就自己在軟件開發(fā)工作中的ShowDoc使用經(jīng)驗(yàn),及使用心得分享給大家:

        一、自行構(gòu)建API文檔本地服務(wù)器。

        本人使用CentOS 7.8 64位系統(tǒng),在本地利用虛擬化平臺布署,因?yàn)镾howDoc使用Docker技術(shù),Docker需要container-selinux包,需要手工安裝,在https://pkgs.org/download下載后,拖入linux后手工安裝:

        cd /opt

        yum localinstall -y container-selinux-2.119.2-1.911c772.el7_8.noarch.rpm

        下面下載ShowDoc,由其自動安裝Docker容器:

        wget https://www.showdoc.com.cn/script/showdoc

        chmod +x showdoc

        ./showdoc

        由于要下載安裝Docker相關(guān)環(huán)境,經(jīng)過漫長時間后,ShowDoc即布署完成。在內(nèi)網(wǎng)即可直接訪問,假定ShowDoc安裝的IP是10.0.0.100:

        http://10.0.0.100/web/#/

        設(shè)置Docker自動啟動ShowDoc:

        systemctl enable docker

        docker update --restart=always showdoc

        二、使用ShowDoc手工、自動編寫、添加文檔

        使用ShowDoc默認(rèn)密碼登錄后,在頁面上新建文檔,即可進(jìn)入某個項(xiàng)目的詳細(xì)文檔編輯頁面,類似于Markdown的編輯頁面,手工編輯一些說明、全局錯誤碼、修改記錄等全局性的API文檔,可以非常方便地便于后端、前端的開發(fā)人員翻閱。

        手工編寫不是開發(fā)人員的常規(guī)選擇,更直接、便利的方式是通過代碼中常規(guī)注釋來自動生成文檔,貼近于后端開發(fā)人員的開發(fā)習(xí)慣,是值得推薦的方式:

        wget https://www.showdoc.cc/script/showdoc_api.sh

        chmod a+x showdoc_api.sh

        wget https://www.showdoc.cc/script/api_demo.test

        api_demo.test是一個示例性的文檔,從中可以拿到完整的注釋參考。編輯showdoc_api.sh,根據(jù)自己項(xiàng)目的具體配置,修改api key和url,即可使showdoc_api與項(xiàng)目專屬文檔形成關(guān)聯(lián)。在程序編寫時,可以在代碼起始處、或每個關(guān)鍵函數(shù)起始處添加如下注釋:

        /**

        * showdoc

        * @catalog 測試文檔/用戶相關(guān)

        * @title 用戶注冊

        * @description 用戶注冊的接口

        * @method post

        * @url https://www.showdoc.com.cn/home/user/login

        * @param username 必選 string 用戶名

        * @param password 必選 string 密碼

        * @param name 可選 string 用戶昵稱

        * @return {"error_code":0,"data":{"uid":"1","username":"12154545","name":"吳系掛

        ","groupid":2,"reg_time":"1436864169","last_login_time":"0"}}

        * @return_param groupid int 用戶組id

        * @return_param name string 用戶昵稱

        * @remark 這里是備注信息

        * @number 99

        */

        我們可以與git配合,做成日志的自動更新,定時啟動showdoc_api.sh,即可自動生成規(guī)整的API文檔,這極大便利于程序文檔的編寫,團(tuán)隊(duì)開發(fā)人員只要形成了約定,在每段關(guān)鍵的API調(diào)用函數(shù)前,使用一些必要的注釋,即可生成規(guī)范的文檔,供后端和前端開發(fā)人員共享使用,大大提高了開發(fā)效率,方便了團(tuán)隊(duì)開發(fā)的規(guī)范形成。

        猜你喜歡
        開發(fā)人員開發(fā)者開源
        五毛錢能買多少頭牛
        Semtech發(fā)布LoRa Basics 以加速物聯(lián)網(wǎng)應(yīng)用
        大家說:開源、人工智能及創(chuàng)新
        開源中國開源世界高峰論壇圓桌會議縱論開源與互聯(lián)網(wǎng)+創(chuàng)新2.0
        16%游戲開發(fā)者看好VR
        CHIP新電腦(2016年3期)2016-03-10 13:06:42
        開源計(jì)算機(jī)輔助翻譯工具研究
        iOS開發(fā)者調(diào)查
        電腦迷(2015年8期)2015-05-30 12:27:10
        iOS開發(fā)者調(diào)查
        電腦迷(2015年4期)2015-05-30 05:24:09
        讓W(xué)indows 10進(jìn)入開發(fā)者模式
        電腦迷(2015年12期)2015-04-29 23:22:51
        后悔了?教你隱藏開發(fā)人員選項(xiàng)
        電腦愛好者(2015年6期)2015-04-03 01:20:56
        国产熟女精品一区二区| 国产av电影区二区三区曰曰骚网| 中文在线√天堂| 亚洲AV手机专区久久精品| 亚洲av无一区二区三区综合| 无码国产精品一区二区免费式芒果| 一本色道久久99一综合| 亚洲人成人一区二区三区| 日韩视频午夜在线观看| 边添小泬边狠狠躁视频| 免费看泡妞视频app| 成 人 网 站 在线 看 免费| 中文字幕亚洲高清精品一区在线| 亚洲自偷自拍另类第1页| 亚洲综合色自拍一区| 亚洲成精品动漫久久精久| av在线播放免费观看| 成年女人a级毛片免费观看| 免费精品无码av片在线观看| 亚洲性爱区免费视频一区| av手机免费在线观看高潮| 性色av免费网站| 欧美成人小视频| 国产亚洲精品高清视频| 国产精品久久久福利| 丰满少妇大力进入av亚洲| 九九久久精品大片| 人妖在线一区二区三区| 国产免费内射又粗又爽密桃视频| 久久国产精品二区99| 天堂av一区一区一区| 日本亲近相奷中文字幕| 内射中出无码护士在线| 久久精品国产成人午夜福利| 日韩av一区二区观看| 天美传媒一区二区| 秋霞日韩一区二区三区在线观看| 亚洲国产91高清在线| 色综合久久久久综合99| 免费人成黄页在线观看视频国产| 久久国产亚洲av高清色|