如何做好 PHP 项目文档管理?PHPer 开发的必备利器!

对于常年写 PHP 的老司机来说,PHPDoc 一定不会陌生,不过从1.3.0开始,更名为 phpDocumentor。它作为一个用 PHP 写的工具,主要作用是从你的源代码的注释中生成文档,因此在给你的程序做注释的过程,也就是你编制文档的过程。这样也促使你要养成良好的编程习惯,尽量使用规范,也避免了事后编制文档和文档的更新不同步的一些问题。

新的版本加上了对 php5 语法的支持,同时,可以通过在客户端浏览器上操作生成文档,文档可以转换为 PDF、HTML、CHM几种形式,非常的方便。不过,传统使用 PHPDoc 工具需要下载安装,过程繁琐,今天给大家推荐码云 PHP 项目的文档自动生成和托管服务。

1. 首先确保项目的编程语言选项是 PHP

如果不是 PHP,请进入项目设置页面,修改编程语言为 PHP。

2. 点击服务菜单中的 PHPDoc 项目

3. 选择要构建文档的分支以及目录

4. 开始自动生成文档并部署

你可以点击 https://apidoc.gitee.com/mirrors/phpDocumentor2/ 这个链接来预览生成文档的效果。当然,记得把生成的文档链接放到项目首页和介绍处,方便你的项目用户浏览和查阅。

如果大家感兴趣,可以去试试:https://gitee.com

掌握了以上几点,基本上就可以利用码云提供的在线生成 PHPDoc 服务为你工作了,提高工作效率。

关注码云微信公众号:mayunOSC

发现更多优质开源项目:最新推荐 – 码云 – 开源中国

团队流畅、高效开发:码云企业版 – 码云 – 开源中国​​​​​

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://xiahunao.cn/news/1381493.html

如若内容造成侵权/违法违规/事实不符,请联系瞎胡闹网进行投诉反馈,一经查实,立即删除!

相关文章

PHP读取word文档 导入word文档

PHP读取word文档 导入word文档 PHP读取word文档 导入word文档libreoffice把word转html用phpquery读取html的内容 PHP读取word文档 导入word文档 前一段时间在工作中遇见了一个棘手的需求,客户要求把word里的数据导入,对数据进行统计。 刚开始觉得挺简单…

开发文档(PHP代码规范)

为什么80%的码农都做不了架构师?>>> 1 框架目录及结构简介 1.1 目录结构 1.2框架简介和主要目录结构简介 1.2.1 框架版本采用:Lumen (5.5.2) (Laravel Components 5.5.*)版本 参考链接:https://lumen.laravel-china.org/docs/5.2…

PHP编码规范文档

为了提高工作效率,保证开发的有效性和合理性,并最大程度提高程序代码的可读性和可重复利用性,提高沟通效率,需要一份代码编写规范。让大家养成良好的代码编写习惯,同时减少代码中的bug。 CleverCode整理了一些规…

PHP文档工具-phpDocumentor

PHP 文档工具 —— phpDocumentor 写文档是一项乏味却不得不做的工作,而编写 API 级的文档更是意味着大量的重复劳动和难以保持的一致性。这里我们要推荐给大家的,是支持 PHP5 语法分析的文档工具—— phpDocumentor 。 使用 phpDocumentor…

unity新输入系统的简单使用(New InputSystem)

1、在包管理器 unity注册表中下载安装InputSystem 2、给玩家添加组件PlayerInput,点击CreatAction,创建一个InputAct InputAct,这是玩家的输入文件,在里面可以设置玩家输入 3、使用 例如玩家控制角色移动 在InputAct中,默认已经设置好了移…

PHP有关文件

目录 1.文件环境变量 2.文件相关知识 3.有关文件函数 2.写文件 3.关闭文件&#xff1a; 4.其他函数 1.文件环境变量 <?php echo $_SERVER[DOCUMENT_ROOT] .PHP_EOL; //根目录的路径 echo $_SERVER[PHP_SELF] .PHP_EOL;//从根目录到文件的路径 echo $_SERVER[SCRIPT_F…

如何使用phpdoc生成PHP文档

1. 下载phpdoc 官网地址&#xff08;已经N久没更新了&#xff0c;不知道是不是不想干了&#xff09;&#xff1a;http://www.phpdoc.org/&#xff1b;下载地址&#xff1a;http://sourceforge.net/projects/phpdocu/files/ 2. phpdoc -h 文件下载后解压&#xff0c;然后进入…

超好用的PHP注解生成Api接口文档工具,支持TP、Lavael、Hyperf、Webman等框架

✨特性 开箱即用&#xff1a;无繁杂的配置、安装后按文档编写注释即可自动生成API文档。轻松编写&#xff1a;支持通用注释引用、业务逻辑层、数据表字段的引用&#xff0c;几句注释即可完成。在线调试&#xff1a;在线文档可直接调试&#xff0c;并支持全局请求/Mock参数/事件…

PHP文档工具

PHP文档工具 ——phpDocumentor Easyphpe / 文 写文档是一项乏味却不得不做的工作&#xff0c;而编写API级的文档更是意味着大量的重复劳动和难以保持的一致性。这里我们要推荐给大家的&#xff0c;是支持PHP5语法分析的文档工具——phpDocumentor。 使用phpDocumentor不仅可以…

PHP写文件简介

PHP中有各种内置函数用于对文件执行各种操作。他们可能对文件进行创建、打开、读取、写入等操作。 PHP写入文件的功能 以下是 PHP 中默认可用的主要功能&#xff1a; 1. fopen() 首先&#xff0c;为了写入文件&#xff0c;我们必须知道如何创建该文件。这是在 open() 函数的…

前端笔试题1

HTML/CSS 题1&#xff1a; 1&#xff0e;使用CSS 让该节点不可见&#xff0c;方法越多越好。 <div class"hidden">Hi</div> 使用CSS 让节点不可见的方法有以下几种&#xff1a; 把 visibility 属性设置为 hidden&#xff0c;这样元素框不会被绘制&…

inkscape制作向日葵

inkscape制作向日葵logo 双击打开inkscape 软件 2.创建一个五角星&#xff0c;填充相应的颜色 3.创建一个圆填充相应的颜色 把五角星增加圆角和辐条&#xff0c; 5.绘制向日葵的眉毛、眼睛、鼻子、嘴巴 6.把圆和五角星重叠在一起&#xff0c;选中五角星——选择图层——层置…

Android_Butterfly_动画

Android_Butterfly_动画 运行效果 所需文件 MainActivity package com.example.a517_butter; import android.animation.AnimatorSet; import android.animation.ObjectAnimator; import android.graphics.drawable.AnimationDrawable; import android.os.Bundle; //imp…

matlab 绘花,MATLAB绘图花样一

多组数据在一张图中显示----hold on x = [5 20 40 60 80 100 120]; y = [-0.2 -0.36 -0.26 -0.24 -0.33 -0.41 -0.55]; y1 = [-0.15 -0.31 -0.21 -0.19 -0.28 -0.36 -0.5]; y2 = [-0.25 -0.41 -0.31 -0.29 -0.38 -0.46 -0.6]; plot(x,y); hold on; plot(x,y1); hold on; plot(x…

R语言笔记(一)

1.iris&#xff1a;鸢尾花数据集 Sepal&#xff1a;花萼 Petal&#xff1a;花瓣 Species&#xff1a;种数 2.sunflowerplot(iris[,4:5],col”gold”,seg.col”gold”) 表示画出向日葵的散点图&#xff0c;iris[,4:5]表示iris数据的第四、五列的数据画向日葵散点图…

python用turtle画太阳花_Python绘图——认识turtle小海龟

海龟作图&#xff0c;turtle是Python重要的标准库之一&#xff0c;我们可以编写指令让一个虚拟的小海龟在屏幕上来回移动。这个海龟带着一只钢笔&#xff08;pen&#xff09;&#xff0c;我们可以让海龟无论移动到哪都使用这只钢笔来绘制线条。 海龟作图最初源自20世纪60年代的…

向日葵android平板,向日葵远程控制 - 黑科技改变生活,让端游一秒变手游 - Android 应用 - iPad - 【最美应用】...

玩主机的看不起玩平台的&#xff0c;玩平台的看不起玩端游的&#xff0c;玩端游的看不起玩页游的&#xff0c;玩页游的还看不起玩手游的。 现在不要分什么彼此了&#xff0c;通过以下方法&#xff0c;想用手机玩平台游戏、玩端游、玩页游&#xff0c;可一次实现&#xff01; 手…

海龟画图 python太阳花_python画图之“小海龟”turtle

“小海龟”turtle是Python语言中一个很流行的绘制图像的函数库&#xff0c;想象一个小乌龟&#xff0c;在一个横轴为x、纵轴为y的坐标系原点&#xff0c;(0,0)位置开始&#xff0c;它根据一组函数指令的控制&#xff0c;在这个平面坐标系中移动&#xff0c;从而在它爬行的路径上…

python turtle库制作可爱的假向日葵

效果图&#xff1a; 是不是很可爱呢&#xff01;现在就带各位朋友们亲手做一个假向日葵花吧 # sun flower 向日葵 # 创作人&#xff1a;李国庆 # 扣扣&#xff1a;1974914843 import turtle as tt.begin_fill() t.pendown() t.circle(60) t.fd(14) t.fillcolor(yellow) t.end…

windows系统链接UBuntu向日葵

参考链接&#xff1a; 1、https://www.pianshen.com/article/67791913548/ 2、https://www.codeleading.com/article/8793979874/ 3、https://www.linuxidc.com/Linux/2011-07/39491.htm 解决方法 1.官网下载: https://sunlogin.oray.com/download/ 双击deb安装&#xff0c;然…