- 使用JSDoc生成漂亮的文档
胡西风_foxww
#JavaScript#vuejsdocjsdoc-vue文档vuejs文档生成
原文地址:https://qdgithub.com/home/index/article/aid/248.html1.什么是JSDocJSDoc是一个用于JavaScript的API文档生成器,类似于Javadoc或phpDocumentor。可以将文档注释直接添加到源代码中。JSDoc工具将扫描您的源代码并为您生成一个HTML文档网站。2.JSDoc可以用来干什么生成清晰文档:通过为函数、方法和
- 玩转微服务-技术篇-JSDOC教程
Elcker
玩转微服务javascript微服务
一.简介JSDoc3是一个用于JavaScript的API文档生成器,类似于Javadoc或phpDocumentor。可以将文档注释直接添加到源代码中。JSDoc工具将扫描您的源代码并为您生成一个HTML文档网站。JSDoc是一种用于JavaScript代码文档注释的标记语言和工具。它不仅仅是一种文档编写方式,更是一种代码规范和团队协作工具。通过使用JSDoc注释,开发人员可以将关于函数、类、方
- 使用jsDoc(注释规范)
smouns_
前端javascript
jsDoc,顾名思义,jsDoc是一个用于JavaScript的API文档生成器,类似于Javadoc或phpDocumentor。它根据JavaScript文件中的注释信息,生成JS应用程序或模块的API文档。通过使用JSDoc标记如:命名空间,类,方法参数等,从而使开发者能够轻易地阅读代码,掌握代码定义的类和和其属性和方法,从而降低维护成本并提高开发效率。JSDoc中文文档JSDoc注释通常应
- 前端教程-文档工具
累牛满面
前端前端
JSDoc入门JSDoc3是一个用于JavaScript的API文档生成器,类似于Javadoc或phpDocumentor。可以将文档注释直接添加到源代码中。JSDoc工具将扫描您的源代码并为您生成一个HTML文档网站。JSDoc官网VuePressVue驱动的静态网站生成器以Markdown为中心的项目结构,以最少的配置帮助你专注于写作。官网docsifydocsify可以快速帮你生成文档网站
- php 的代码解析相关的扩展
sorry510
https://github.com/PHP-DI/PhpDocReader在PHPdocblocks注释中解析@varand@param的值https://github.com/Roave/BetterReflection更好的反射解析工具https://github.com/phpDocumentor/phpDocumentor注释文档解析工具https://github.com/nikic/
- php经常用到的一些composer包
a7442358
phpcomposer
列举一些对开发有帮助的composer包,对于各个包的安装和使用不在这里做过多的介绍,持续更新。1.phpDocumentor对于有规范注释的PHP文件,生成对应的注释文档。GitHub地址:https://github.com/phpDocumentor/phpDocumentor2composerrequire"phpdocumentor/phpdocumentor:2.*"2.PHP-CS-
- PHPDoc/PHPDocumentor生成API文档
r_martian
PHP
PHPDocumentor是一个用PHP写的强大的文档自动生成工具,对于有规范注释的php程序,能够快速生成具有结构清晰、相互参照、索引等功能的API文档。旧版本是PHPDoc,PHPDoc是PEAR下面的一个非常优秀的模块,类似于javadoc。从1.3.0开始,更名为phpDocumentor,新版本新加了对php5语法的支持,同时,可以通过在客户端浏览器上操作生成文档,文档可以转换为PDF、
- PHP编码规范-笔记
Towering~
所有的代码都要变成可供他人容易阅读的良好的代码书写习惯+良好的注释习惯+PhpDocumentor=程序说明书整理日期:2013-07-30为什么要编码规范:编码规范(codeconventions)对于程序员而言尤为重要,有以下几个原因:1.在一个软件的生命周期中,80%的花费用于维护。2.几乎没有任何一个软件在其整个生命周期中均由最初的开发人员来维护。3.编码规范可以改善软件的可读性,可以让程
- PHP注释生成文档
w_w_wei
PHP注释为了让代码更具可读性,需要给出一些关键的提示注释,为了跟好的生成帮助文档,更需要对注释进行规范。这里选用了PhpDocumentor的注释风格,如果需要生成文档,也只要用工具直接生成就行了。关于PhpDocumentor项目地址:https://github.com/phpDocumentor/phpDocumentor2Composer:https://packagist.org/pa
- 完美解决phpdoc导出文档中@package的warning及Error的错误
今天在编写PHPDoc的导出文档的时候发现一个很郁闷的错误,虽然这个warning不是什么重要错误,但是看着总是很不爽的。于是就去网上找了很多相关的资料,可是郁闷的是不知道是我用的PHPDoc版本太新(1.4的版本),还是说很多人都没遇到这个问题,反正就是没有相关的这个资料找到,只是找到了一些从PHPDocumentor官方网倒出来的关于@package的使用注意事项,然后就只能一条一条检查,看了
- PHP注释标记整理
烟草的香味.
PHP
什么是注释标记我们在平常写代码或看别人写的代码时,在方法的说明注释中经常会有这样的注释:/***@param$num*@returnarray*/上面的*@param*@return就是注释标记注释标记用于生成文档,param指明需要接收的参数,return指明返回值在使用phpDocumentor等工具生成文档时,会识别相关注释,而且IDE也会识别,在编码的过程中会给出提示.PHP注释标记总结@
- PHP 规范开发(四):重构、代码规范及设计模式
半斤桃花
代码规范重构和设计模式
预期学习目标重构:改善既有代码的设计代码简洁之道程序员修炼之道设计模式写代码总结四本书的学习心得语法糖可变数量的参数列表类似与func_get_args()functionsum(...$numbers){$acc=0;foreach($numbersas$n){$acc+=$n;}return$acc;}echosum(1,2,3,4);#将会输出:10注释规范PHPDocumentor代码解耦
- 如何做好 PHP 项目文档管理?PHPer 开发的必备利器!
zicochan
对于常年写PHP的老司机来说,PHPDoc一定不会陌生,不过从1.3.0开始,更名为phpDocumentor。它作为一个用PHP写的工具,主要作用是从你的源代码的注释中生成文档,因此在给你的程序做注释的过程,也就是你编制文档的过程。这样也促使你要养成良好的编程习惯,尽量使用规范,也避免了事后编制文档和文档的更新不同步的一些问题。新的版本加上了对php5语法的支持,同时,可以通过在客户端浏览器上操
- Phpdocumentor使用心得
久度
如果你是一名码农,除了敲代码之外还要做一些琐事例如:写文档。那么你就应该学会使用工具自动生成,这样会大大提高工作效率。下面介绍一下笔者自行研究的phpdocumentor,欢迎讨论。首先说明一下笔者环境:window系统xampp集成环境php安装目录:G:xampp/php先附一张简单的phpdocumentor生成图:Phpdocumentor使用心得一、非集成环境1、依赖pear安装:a)安
- 基础级-phpDocumentor
m18779186977
PHP文档团队协作
设想一下,你自己设计、书写的程序,倘若无需他人参与,你是否就不需要文档?时隔一年,你还能记清代码中的细节吗?一个方法的参数是整型,还是字符串类型?亦或是布尔型?编程作为一种兴趣,我对它报以热情、投入成本,自然就不希望:我亲手书写的代码,变成盘根错节的麻绳,绊倒我自己。毕竟,我们很难追踪系统的工作方式和编码目的,对于一个大型项目来说,往往文档会成为致命级的存在。用法格式特殊关键字结语用法在phpDo
- php文档工具PHP Documentor安装与使用方法
张映
本文讲述了php文档工具PHPDocumentor安装与使用方法。分享给大家供大家参考,具体如下:PHPDocumentor是PEAR下面的一个模块,用来生成文档。PHPDocumentor扫描指定目录下面的php源代码,扫描其中的关键字,截取需要分析的注释,然后分析注释中的专用的tag,生成html文件,接着根据已经分析完的类和模块的信息,建立相应的索引,生成html文件。在review代码的时
- PhpDocumentor
素人派surenpi
phpdocumentor
PhpDocumentor是PHP写的,用来生成PHP文档的一个工具。安装方法pearinstallPhpDocumentor
- PhpDocumentor
素人派surenpi
phpdocumentor
PhpDocumentor是PHP写的,用来生成PHP文档的一个工具。安装方法pearinstallPhpDocumentor
- PHP Document 代码注释规范
document
HPDocumentor是一个用PHP写的工具,对于有规范注释的php程序,它能够快速生成具有相互参照,索引等功能的API文档。老的版本是 phpdoc。
1. 什么是phpDocumentor ?
PHPDocumentor 是一个用PHP写的工具,对于有规范注释的php程序,它能够快速生成具有相互参照,索引等功能的API文档。老的版本是 phpdoc,从1.3.0开始,更名为phpDocu
- 如何正确安装phpDocumentor
document
我们在进行PHP环境配置时,需要对phpDocumentor进行安装,那么如何才能正确的实现安装呢?我们介绍了两种方法。安装phpDocumentor的第一种方式是从pear.php.net 或 sourceforge.net下载压缩包并解压。另一种方式是通过pear安装
为你解读PHP realpath路径函数
深入分析几种PHP获取客户端IP的情况
解读PHP函数strrev
- PHPDocumentor代码注释规范说明
document
PHPDocumentor是一个的用PHP写的道具,对于有规则注释的php程序,它能够快速生成具有相互参照,索引等功能的API文档。 标记 用途 描述 @abstract 抽象类的变量和方法 @access public, private or protected 文档的访问、使用权限. @access private 表明这个文档是被保护的。
- windows下安装PhpDocumentor(phpdoc)笔记
document
PhpDocumentor简介
PHPDocumentor是一个用PHP写的工具,对于有规范注释的php程序,它能够快速生成具有相互参照,索引等功能的API文档。老的版本是phpdoc,从1.3.0开始,更名为phpDocumentor,新的版本加上了对php5语法的支持,同时,可以通过在客户端浏览器上操作生成文档,文档可以转换为PDF,HTML,CHM几种形式,非常的方便。
&nbs
- PHP编程规范
PHP
一直以来我都是以php函数的风格来写php,所有变量,函数,类都使用小写,单词之间以下划线隔开,一直比较排斥驼峰式的代码规范,个人觉得在大小写字母之间的书写代码,很麻烦,而且PHP自己的函数都是小写,为什么我不用这种格式呢?
良好的代码书写习惯 + 良好的注释习惯 + PhpDocumentor = 程序说明书
一个团队,必须有整齐的代码书写习惯,如果再配上统一的IDE开发环境,详细的任
- 修改PhpDocumentor默认编码
document
最近项目需要
phpdoc生成文档,首先安装
phpDocumentor,利用pear安装:
切换用户:
su root 安装PhpDocumentor:
pear install PhpDocumentor 生成文档:
phpdoc -o HTML:frames:earthli -d CustomService/ -t docs/ &nbs
- Zend Framework的PHP编码规范【2】
framework
4.4. 类 4.4.1. 类的声明
类的声明应该遵守以下要求:
l 大括号必须写在类名字的下一行;
l 每个类都必须有一个遵守PHPDocumentor标准的注释文档块;
l &n
- PHPDocumentor代码注释规范说明
document
PHPDocumentor是一个的用PHP写的道具,对于有规则注释的php程序,它能够快速生成具有相互参照,索引等功能的API文档。 标记 用途 描述 @abstract 抽象类的变量和方法 @access public, private or protected 文档的访问、使用权限. @access private 表明这个文档
- phpDocumentor学习使用记录
wms3001
浏览器客户端记录PHP程序
phpDocumentor学习使用记录一.phpDocumentor简介PHPDocumentor是一个用PHP写的工具,对于有规范注释的php程序,它能够快速生成具有相互参照,索引等功能的API文档。老的版本是phpdoc,从1.3.0开始,更名为phpDocumentor,新的版本加上了对php5语法的支持,同时,可以通过在客户端浏览器上操作生成文档,文档可以转换为PDF,HTML,CHM几种
- phpDocumentor学习使用记录
wms3001
浏览器客户端记录PHP程序
phpDocumentor学习使用记录一.phpDocumentor简介PHPDocumentor是一个用PHP写的工具,对于有规范注释的php程序,它能够快速生成具有相互参照,索引等功能的API文档。老的版本是phpdoc,从1.3.0开始,更名为phpDocumentor,新的版本加上了对php5语法的支持,同时,可以通过在客户端浏览器上操作生成文档,文档可以转换为PDF,HTML,CHM几种
- phpDocumentor学习使用记录
一耳听世界
phpDocumentor学习使用记录一.phpDocumentor简介PHPDocumentor是一个用PHP写的工具,对于有规范注释的php程序,它能够快速生成具有相互参照,索引等功能的API文档。老的版本是phpdoc,从1.3.0开始,更名为phpDocumentor,新的版本加上了对php5语法的支持,同时,可以通过在客户端浏览器上操作生成文档,文档可以转换为PDF,HTML,CHM几种
- php一键环境包xammp 安装 phpDocumentor
wms3001
targetblankPHP程序
1.phpDocumentor简介。PHPDocumentor是一个用PHP写的工具,对于有规范注释的php程序,它能够快速生成具有相互参照,索引等功能的API文档。老的版本是phpdoc,从1.3.0开始,更名为phpDocumentor,新的版本加上了对php5语法的支持,同时,可以通过在客户端浏览器上操作生成文档,文档可以转换为PDF,HTML,CHM几种形式,非常的方便。phpDocum
- rust的指针作为函数返回值是直接传递,还是先销毁后创建?
wudixiaotie
返回值
这是我自己想到的问题,结果去知呼提问,还没等别人回答, 我自己就想到方法实验了。。
fn main() {
let mut a = 34;
println!("a's addr:{:p}", &a);
let p = &mut a;
println!("p's addr:{:p}", &a
- java编程思想 -- 数据的初始化
百合不是茶
java数据的初始化
1.使用构造器确保数据初始化
/*
*在ReckInitDemo类中创建Reck的对象
*/
public class ReckInitDemo {
public static void main(String[] args) {
//创建Reck对象
new Reck();
}
}
- [航天与宇宙]为什么发射和回收航天器有档期
comsci
地球的大气层中有一个时空屏蔽层,这个层次会不定时的出现,如果该时空屏蔽层出现,那么将导致外层空间进入的任何物体被摧毁,而从地面发射到太空的飞船也将被摧毁...
所以,航天发射和飞船回收都需要等待这个时空屏蔽层消失之后,再进行
&
- linux下批量替换文件内容
商人shang
linux替换
1、网络上现成的资料
格式: sed -i "s/查找字段/替换字段/g" `grep 查找字段 -rl 路径`
linux sed 批量替换多个文件中的字符串
sed -i "s/oldstring/newstring/g" `grep oldstring -rl yourdir`
例如:替换/home下所有文件中的www.admi
- 网页在线天气预报
oloz
天气预报
网页在线调用天气预报
<%@ page language="java" contentType="text/html; charset=utf-8"
pageEncoding="utf-8"%>
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transit
- SpringMVC和Struts2比较
杨白白
springMVC
1. 入口
spring mvc的入口是servlet,而struts2是filter(这里要指出,filter和servlet是不同的。以前认为filter是servlet的一种特殊),这样就导致了二者的机制不同,这里就牵涉到servlet和filter的区别了。
参见:http://blog.csdn.net/zs15932616453/article/details/8832343
2
- refuse copy, lazy girl!
小桔子
copy
妹妹坐船头啊啊啊啊!都打算一点点琢磨呢。文字编辑也写了基本功能了。。今天查资料,结果查到了人家写得完完整整的。我清楚的认识到:
1.那是我自己觉得写不出的高度
2.如果直接拿来用,很快就能解决问题
3.然后就是抄咩~~
4.肿么可以这样子,都不想写了今儿个,留着作参考吧!拒绝大抄特抄,慢慢一点点写!
- apache与php整合
aichenglong
php apache web
一 apache web服务器
1 apeche web服务器的安装
1)下载Apache web服务器
2)配置域名(如果需要使用要在DNS上注册)
3)测试安装访问http://localhost/验证是否安装成功
2 apache管理
1)service.msc进行图形化管理
2)命令管理,配
- Maven常用内置变量
AILIKES
maven
Built-in properties
${basedir} represents the directory containing pom.xml
${version} equivalent to ${project.version} (deprecated: ${pom.version})
Pom/Project properties
Al
- java的类和对象
百合不是茶
JAVA面向对象 类 对象
java中的类:
java是面向对象的语言,解决问题的核心就是将问题看成是一个类,使用类来解决
java使用 class 类名 来创建类 ,在Java中类名要求和构造方法,Java的文件名是一样的
创建一个A类:
class A{
}
java中的类:将某两个事物有联系的属性包装在一个类中,再通
- JS控制页面输入框为只读
bijian1013
JavaScript
在WEB应用开发当中,增、删除、改、查功能必不可少,为了减少以后维护的工作量,我们一般都只做一份页面,通过传入的参数控制其是新增、修改或者查看。而修改时需将待修改的信息从后台取到并显示出来,实际上就是查看的过程,唯一的区别是修改时,页面上所有的信息能修改,而查看页面上的信息不能修改。因此完全可以将其合并,但通过前端JS将查看页面的所有信息控制为只读,在信息量非常大时,就比较麻烦。
- AngularJS与服务器交互
bijian1013
JavaScriptAngularJS$http
对于AJAX应用(使用XMLHttpRequests)来说,向服务器发起请求的传统方式是:获取一个XMLHttpRequest对象的引用、发起请求、读取响应、检查状态码,最后处理服务端的响应。整个过程示例如下:
var xmlhttp = new XMLHttpRequest();
xmlhttp.onreadystatechange
- [Maven学习笔记八]Maven常用插件应用
bit1129
maven
常用插件及其用法位于:http://maven.apache.org/plugins/
1. Jetty server plugin
2. Dependency copy plugin
3. Surefire Test plugin
4. Uber jar plugin
1. Jetty Pl
- 【Hive六】Hive用户自定义函数(UDF)
bit1129
自定义函数
1. 什么是Hive UDF
Hive是基于Hadoop中的MapReduce,提供HQL查询的数据仓库。Hive是一个很开放的系统,很多内容都支持用户定制,包括:
文件格式:Text File,Sequence File
内存中的数据格式: Java Integer/String, Hadoop IntWritable/Text
用户提供的 map/reduce 脚本:不管什么
- 杀掉nginx进程后丢失nginx.pid,如何重新启动nginx
ronin47
nginx 重启 pid丢失
nginx进程被意外关闭,使用nginx -s reload重启时报如下错误:nginx: [error] open() “/var/run/nginx.pid” failed (2: No such file or directory)这是因为nginx进程被杀死后pid丢失了,下一次再开启nginx -s reload时无法启动解决办法:nginx -s reload 只是用来告诉运行中的ng
- UI设计中我们为什么需要设计动效
brotherlamp
UIui教程ui视频ui资料ui自学
随着国际大品牌苹果和谷歌的引领,最近越来越多的国内公司开始关注动效设计了,越来越多的团队已经意识到动效在产品用户体验中的重要性了,更多的UI设计师们也开始投身动效设计领域。
但是说到底,我们到底为什么需要动效设计?或者说我们到底需要什么样的动效?做动效设计也有段时间了,于是尝试用一些案例,从产品本身出发来说说我所思考的动效设计。
一、加强体验舒适度
嗯,就是让用户更加爽更加爽的用你的产品。
- Spring中JdbcDaoSupport的DataSource注入问题
bylijinnan
javaspring
参考以下两篇文章:
http://www.mkyong.com/spring/spring-jdbctemplate-jdbcdaosupport-examples/
http://stackoverflow.com/questions/4762229/spring-ldap-invoking-setter-methods-in-beans-configuration
Sprin
- 数据库连接池的工作原理
chicony
数据库连接池
随着信息技术的高速发展与广泛应用,数据库技术在信息技术领域中的位置越来越重要,尤其是网络应用和电子商务的迅速发展,都需要数据库技术支持动 态Web站点的运行,而传统的开发模式是:首先在主程序(如Servlet、Beans)中建立数据库连接;然后进行SQL操作,对数据库中的对象进行查 询、修改和删除等操作;最后断开数据库连接。使用这种开发模式,对
- java 关键字
CrazyMizzz
java
关键字是事先定义的,有特别意义的标识符,有时又叫保留字。对于保留字,用户只能按照系统规定的方式使用,不能自行定义。
Java中的关键字按功能主要可以分为以下几类:
(1)访问修饰符
public,private,protected
p
- Hive中的排序语法
daizj
排序hiveorder byDISTRIBUTE BYsort by
Hive中的排序语法 2014.06.22 ORDER BY
hive中的ORDER BY语句和关系数据库中的sql语法相似。他会对查询结果做全局排序,这意味着所有的数据会传送到一个Reduce任务上,这样会导致在大数量的情况下,花费大量时间。
与数据库中 ORDER BY 的区别在于在hive.mapred.mode = strict模式下,必须指定 limit 否则执行会报错。
- 单态设计模式
dcj3sjt126com
设计模式
单例模式(Singleton)用于为一个类生成一个唯一的对象。最常用的地方是数据库连接。 使用单例模式生成一个对象后,该对象可以被其它众多对象所使用。
<?phpclass Example{ // 保存类实例在此属性中 private static&
- svn locked
dcj3sjt126com
Lock
post-commit hook failed (exit code 1) with output:
svn: E155004: Working copy 'D:\xx\xxx' locked
svn: E200031: sqlite: attempt to write a readonly database
svn: E200031: sqlite: attempt to write a
- ARM寄存器学习
e200702084
数据结构C++cC#F#
无论是学习哪一种处理器,首先需要明确的就是这种处理器的寄存器以及工作模式。
ARM有37个寄存器,其中31个通用寄存器,6个状态寄存器。
1、不分组寄存器(R0-R7)
不分组也就是说说,在所有的处理器模式下指的都时同一物理寄存器。在异常中断造成处理器模式切换时,由于不同的处理器模式使用一个名字相同的物理寄存器,就是
- 常用编码资料
gengzg
编码
List<UserInfo> list=GetUserS.GetUserList(11);
String json=JSON.toJSONString(list);
HashMap<Object,Object> hs=new HashMap<Object, Object>();
for(int i=0;i<10;i++)
{
- 进程 vs. 线程
hongtoushizi
线程linux进程
我们介绍了多进程和多线程,这是实现多任务最常用的两种方式。现在,我们来讨论一下这两种方式的优缺点。
首先,要实现多任务,通常我们会设计Master-Worker模式,Master负责分配任务,Worker负责执行任务,因此,多任务环境下,通常是一个Master,多个Worker。
如果用多进程实现Master-Worker,主进程就是Master,其他进程就是Worker。
如果用多线程实现
- Linux定时Job:crontab -e 与 /etc/crontab 的区别
Josh_Persistence
linuxcrontab
一、linux中的crotab中的指定的时间只有5个部分:* * * * *
分别表示:分钟,小时,日,月,星期,具体说来:
第一段 代表分钟 0—59
第二段 代表小时 0—23
第三段 代表日期 1—31
第四段 代表月份 1—12
第五段 代表星期几,0代表星期日 0—6
如:
*/1 * * * * 每分钟执行一次。
*
- KMP算法详解
hm4123660
数据结构C++算法字符串KMP
字符串模式匹配我们相信大家都有遇过,然而我们也习惯用简单匹配法(即Brute-Force算法),其基本思路就是一个个逐一对比下去,这也是我们大家熟知的方法,然而这种算法的效率并不高,但利于理解。
假设主串s="ababcabcacbab",模式串为t="
- 枚举类型的单例模式
zhb8015
单例模式
E.编写一个包含单个元素的枚举类型[极推荐]。代码如下:
public enum MaYun {himself; //定义一个枚举的元素,就代表MaYun的一个实例private String anotherField;MaYun() {//MaYun诞生要做的事情//这个方法也可以去掉。将构造时候需要做的事情放在instance赋值的时候:/** himself = MaYun() {*
- Kafka+Storm+HDFS
ssydxa219
storm
cd /myhome/usr/stormbin/storm nimbus &bin/storm supervisor &bin/storm ui &Kafka+Storm+HDFS整合实践kafka_2.9.2-0.8.1.1.tgzapache-storm-0.9.2-incubating.tar.gzKafka安装配置我们使用3台机器搭建Kafk
- Java获取本地服务器的IP
中华好儿孙
javaWeb获取服务器ip地址
System.out.println("getRequestURL:"+request.getRequestURL());
System.out.println("getLocalAddr:"+request.getLocalAddr());
System.out.println("getLocalPort:&quo