使用 ApiGen 生成开发文档

最新推荐文章于 2024-06-28 22:00:00 发布
最新推荐文章于 2024-06-28 22:00:00 发布
阅读量1.4k 收藏 1
点赞数
分类专栏： php 文章标签： apigen 文档 phpdocument php bootstrap
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/lsg9012/article/details/43017791
版权

近日项目开发完了之后，需要整理文档，因为之前使用 PHPDocument 生成过，但是界面看着不爽，遂尝试了 ApiGen 生成，不得不说界面看着舒服多了。

下面说说安装和使用的方法吧。


ApiGen官网: http://www.apigen.org/

一、从 github 获取 Windows 的安装包

https://github.com/apigen/apigen/downloads

选择 Version x.x.x standalone package (zip)


二、检测、安装运行环境

1.进入PHP安装目录，按住shift键右击鼠标，点击“在此处打开命令窗口”(或使用cmd.exe进入目录)，运行如下命令:

pear config-set auto_discover 1

运行的结果：

D:\php>pear config-set auto_discover 1
config-set succeeded

如果运行结果如上，直接进入“三、安装ApiGen”，否则如下步骤安装pear


2.安装pear

PHP官网下载： http://pear.php.net/go-pear.phar

然后将文件拷贝到PHP的安装根目录下，按上面的方式打开命令窗口，执行命令:


                

        

        

    

  


        

            

                    
                      最低0.47元/天 解锁文章
                        
                    
            

        

    

      

        

            

              
                
                  拭血
                
              
            

            

                关注
              
            

        

        

          
      

      

            

                专栏目录
          









                



	

		

			

				
					
api idea 开发rest_GitHub - designDo/api-gen: 基于retrofit-dart RestAPI开发的 IDEA 插件，用来生成代码 https://pub.dev...

				
			

			

				

					weixin_39517797的博客
				

				

					01-14
					
					159
					
				

			

		

		

			
				
api-gen基于retrofit-dart RestAPI开发的 IDEA 插件，用来生成代码 https://pub.dev/packages/retrofit由于dart没有反射机制，不能像原生一样实现Retrofit那样简单，而是要借助一些工具提高开发效率。Retrofit官方提供了一种方式，Retrofit他是基于source-gen等dart packages 用来生成代码的工具，有些...

			
		

	



                

              
                



	

		

			

				
					
APIGenAPI

				
			

			

				

					08-07
				

			

		

		

			
				
APIGen：一个智能和可读的API文档生成器

			
		

	



                


  
              

                


	

		

			

				
					
apigen

				
			

			

				

					weixin_33895475的博客
				

				

					03-14
					
					126
					
				

			

		

		

			
				
为什么80%的码农都做不了架构师？>>> 
                                        
                ...

			
		

	





	

		

			

				
					
APIGen:自动生成可验证和多样化函数调用数据集的创新框架

					
最新发布

				
			

			

				

					步子哥的博客
				

				

					06-28
					
					1612
					
				

			

		

		

			
				
为了解决上述问题,论文提出了APIGen,一个自动化的数据生成管道,用于创建可验证、多样化的函数调用数据集。多阶段验证流程: 确保生成数据的质量和可靠性多样化的采样策略: 提高数据集的覆盖范围和代表性统一的JSON格式: 提高框架的可扩展性和适应性大规模、高质量的函数调用数据集: 涵盖21个类别的3,673个可执行API。

			
		

	



		

			
		



	

		

			

				
					
javaweb简单的登录增删改查系统_程序员的福音零代码开发系统来了，再也不用编写增删改查代码了...

				
			

			

				

					weixin_39912368的博客
				

				

					11-23
					
					324
					
				

			

		

		

			
				
CRUD程序员的福音-零代码WebAPI快速开发系统，零代码开发API接口，零代码快速开发微服务接口一、数据库管理：可以创建、删除，查询数据库表二、API管理：可以创建、修改、删除、查询API接口，自定义API接口查询条件、数据表连接条件、分组统计、返回字段格式等说明：零代码WebAPI快速开发系统可以实现无需编写任何代码，通过网页配置即可生成API接口的功能，节省大量重复开发的CRUD代码，(复...

			
		

	





	

		

			

				
					
apigen-generator:基于 Web 的服务，可为您的 PHP GitHub 存储库生成 API 文档

				
			

			

				

					06-26
				

			

		

		

			
				
- 使用ApiGen时，确保PHP代码遵循良好的注释规范，以便生成的文档更准确。 - 虽然ApiGen能自动检测更新，但建议定期检查和更新文档，确保其与最新代码一致。 - 对于私有项目，确保在GitHub上进行适当权限设置，以免...

			
		

	





	

		

			

				
					
Java源码管理-javax-management-tools-apigen:JavaAPI源代码生成器，可与通过JMX公开的MBean进行交

				
			

			

				

					05-19
				

			

		

		

			
				
开发者可以通过阅读这些文档来快速上手使用和理解apigen。  总的来说，Java源码管理-javax-management-tools-apigen是Java开发中的一个实用工具，它简化了与JMX MBeans交互的过程，使代码更易于理解和维护。通过开源...

			
		

	





	

		

			

				
					
ApiGen-2.8.0-standalone

				
			

			

				

					11-02
				

			

		

		

			
				
总之，ApiGen是一个强大的PHP API文档生成工具，2.8.0版本提供了稳定性和兼容性的保障，使得开发者可以更加便捷地为PHP项目生成高质量的API文档，提升项目整体的专业形象和开发效率。无论是初学者还是经验丰富的...

			
		

	





	

		

			

				
					
ApiGen安装

				
			

			

				

					weixin_34177064的博客
				

				

					02-02
					
					128
					
				

			

		

		

			
				
# 首先，下载ApiGen（http://apigen.org/apigen.phar）
# *nix系统
下载phar文件后, 移动到PATH目录中，以保证全局有权限调用

$ mv apigen.phar /usr/local/bin/apigen

现在你可以使用简洁的apigen替代php apigen.phar
# Windows系统
移动phar文件到环境变量P...

			
		

	





	

		

			

				
					
ApiGen-masterAPI文档PHP库.zip

				
			

			

				

					07-11
				

			

		

		

			
				
<?php declare(strict_types=1);
$rootDir = realpath(__DIR__ . '/../');
// Autoloader for standalone install (installed via `composer create-project` or cloned locally)
$autoloader = realpath($rootDir . '/vendor/autoload.php');
if (! $autoloader) {
    // Installed via `composer [global] require`.
    $autoloader = realpath($rootDir . '/../../autoload.php');
}
if (! $autoloader) {
    throw new RuntimeException(
        'ApiGen was unable to find its autoloader. ' .
        'Did you forget to run "composer update"?'
    );
}
require_once $autoloader;PhalApi 1.x 是经典封存版本，已停止更新，历练考验，可放心使用。主要采用PEAR命名规范，遵循PSR-0，不支持命名空间和composer。PhalApi 1.x 支持PHP 5.3及以上版本，并支持PHP 7。
             

			
		

	





	

		

			

				
					
使用phpdoc/phpDocumentor来生成api文档

				
			

			

				

					04-27
				

			

		

		

			
				
使用phpdoc/phpDocumentor来生成api文档
使用方法见:
http://blog.csdn.net/websites/article/details/45308835

			
		

	





	

		

			

				
					
php apigen,APIGen：一个智能和可读的API文档生成器

				
			

			

				

					weixin_39637711的博客
				

				

					03-13
					
					99
					
				

			

		

		

			
				
Smart and Readable Documentation for your PHP project     RequirementsPHP 5.5Install1. Using Composer (preferred method)In your project's root folder:composer require --dev apigen/apigenOr if you want...

			
		

	





	

		

			

				
					
APIGen

				
			

			

				

					weixin_44091497的博客
				

				

					03-04
					
					968
					
				

			

		

		

			
				
API能使开发人员访问、使用外部资源，提高开发效率，现今API库高速发展，为特定的编程需求推荐API是当前开发人员面临的巨大挑战基于检索的方法受限于嵌入模型的表示能力基于学习的方法受限于任务领域训练数据不足APIGen两个组成部分：多样化的示例选择和引导式 API 推荐。三个主要阶段：示例检索、提示构建和 API 推荐。示例检索阶段，APIGen 使用给定的查询从 API 相关帖子语料库中搜索相关帖子。相关帖子将作为下面阶段的演示示例，每个帖子都包含一个编程问题及其相应的 API 答案。

			
		

	





	

		

			

				
					
php apigen,[转]netbean下利用apigen生成php文档安装配置

				
			

			

				

					weixin_36181282的博客
				

				

					03-13
					
					120
					
				

			

		

		

			
				
利用piwigo进行了项目的二次开发之后，有感于这个开源框架的博大精深，想留个念想，所以想利用phpDocumentor在sublime下面生成文档。安装之后，控制台报错。找群友商量之后，有朋友推荐用netbean与apigen配合生成文档。而且这位群友还来出了自己生的案例。感觉用netbean与apigen生成的文档的界面的确舒服，加上sublime下面的phpDocumentor出错提示，也让...

			
		

	





	

		

			

				
					
使用ApiGen生成文档

				
			

			

				

					culi3182的博客
				

				

					08-11
					
					182
					
				

			

		

		

			
				
If you’ve ever worked with someone else’s code, you know the pain (or pleasure) of missing (or existing) documentation. Well documented code is one of the cornerstones of professional software develop...

			
		

	





	

		

			

				
					
php apigen,ApiGen4.0配置项，apigen4.0配置_PHP教程

				
			

			

				

					weixin_30990821的博客
				

				

					03-13
					
					94
					
				

			

		

		

			
				
ApiGen 4.0配置项，apigen4.0配置Usage:generate [-s|--source="..."] [-d|--destination="..."] [--access-levels="..."] [--base-url="..."] [--config="..."] [--google-cse-id="..."] [--google-analytics="..."] [--d...

			
		

	





	

		

			

				
					
php自动执行php文件,使用ApiGen自动生成php文档

				
			

			

				

					weixin_31260665的博客
				

				

					03-10
					
					191
					
				

			

		

		

			
				
ApiGen 是一个自动生成html文档的一个工具，使用php语言编写详细信息请访问：在GitHub上的ApiGen这里介绍如何安装和使用这个工具1. 安装运行环境PHP5.5windows系统建议将php目录加入path变量Linux系统的安装方法[codesyntax lang=”bash” lines=”no” blockstate=”expanded”]wget http://apigen...

			
		

	





	

		

			

				
					
TOM与ApiGen集成：Eclipse中的模式匹配程序IDE增强

				
			

			

				

					
				

			

		

		

			
				
ApiGen则是一个基于抽象语法树（AST）的生成器，它与TOM紧密配合，提供了自然的交互性。通过这种方式，开发者可以更专注于业务逻辑，而不必过于关注底层数据表示的细节。Eclipse作为一个灵活的集成开发环境（IDE），...

			
		

	



              




          




        



    





    



      

      

        
      

      





	

		评论	
	

	
	




  

    

      添加红包
      
    

    

      

        
        

          
          
        

        
请填写红包祝福语或标题

      

      

        
        

          
          个
        

        
红包个数最小为10个

      

      

        
        

          
          元
        

        
红包金额最低5元

      

      

        
        

          当前余额3.43元
          前往充值 >
        

      

      

        

          需支付：10.00元
        

        
        
      

    

  





  

    
    
  

  

    
    
  








  

    

      

        

          

            
            
成就一亿技术人!

          

          

        

        

          

          

            领取后你会自动成为博主和红包主的粉丝
            规则
          

        

      

      

        

          

            
              
            
            

              
hope_wisdom
 发出的红包
            

          

        

        

          

          

          

        

      

    

    

  



      
      

      
实付元

      
使用余额支付

      

        

          

            
            点击重新获取
          

        

        
扫码支付

      

      

        
          
            
          
          
        
      

      

        
        钱包余额
          0
          

            
            

              

                
抵扣说明：

                
 1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
 2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

              

            

          

      

      余额充值