私信发送成功
Watch Star Fork

桔子 / perl6docPerlArtistic-2.0

perl6官方文档,汉化工程
克隆/下载
Orange 最后提交于 2017-11-15 14:55 更新
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README.md 5.59 KB

p6doc -- Perl6的'perldoc'

该文档的html版本链接为: https://docs.perl6.org/.

(如果你通过 github浏览本仓库, 显示可能会部分不协调的,因为使用Perl 6 Pod格式, github用的 Perl 5 POD).

文档中文化进度

Perl6常见问题

感谢araraloren的翻译

从Perl5到Perl6初步

从Perl5到Perl6指南——语法

从Perl5到Perl6指南——函数

从Perl5到Perl6指南——变量

从Perl5到Perl6指南——操作符

从Ruby到Perl6初步

安装

本模块可以用过 Perl6 模块生态体系安装,命令为:

zef install p6doc

通过以上命令安装二进制版本,并且确保安装了正确的执行路径下

下载安装正常后, 运行

p6doc-index build

创建索引。

使用

通过Rakudo安装目录perl6可以运行

./bin/p6doc Str

查看类Str的文档,或者通过

./bin/p6doc Str.split

查看类Str的方法split的文档。你可以跳过./bin部分,如果你通过panda或者zef安装了此模块的话 你也可执行

p6doc -f slurp

来浏览标准函数的文档的,根据你硬盘的速度和Rakudo版本,这个命令可能要慢一点

生成HTML文档

在你的项目目录通过以下命令安装依赖包

panda installdeps .       # panda
zef --depsonly install .  # zef

如果你用的是rakudobrew, 你也可以通过执行下面的命令能够 升级各个模块。

rakudobrew rehash

同时你也必须安装graphviz依赖,用来生成各种图形,在Debian系统你可以通过以下命令安装

sudo apt-get install graphviz

通过以下命令生成文档的web页面:

$ make html

页面生成以后,你就可以在本地浏览。你通过以下命名启动app.pl的程序(Mojo程序)

$ make run

这样你就可以通过浏览器输入网址http://localhost:3000浏览文档

注意:你必须安装了 Mojolicious 你还的需要nodejs来实现高亮。

给予帮助!

Perl6工程 并非一个小项目,项目文档需要投入大量的人力精力,我们感谢你给予任何的帮助。 您可以通过各种方式帮助我们:

  • 给类,角色,方法或者操作符等补充缺失的文档
  • 给已有的文档补充使用实例
  • 校对所有文档
  • 通过github提交问题报告缺失的文档
  • 通过本仓库的 git grep TODO ,找出TODO项并将其文档化
  • 将本项目国际化(翻译成各国语言)

项目问题 项目问题页面列出了当前的问题和已知缺失的文档 和 CONTRIBUTING 简要说明如何开始提供文档。


答疑解惑:

Q: 为什么本文当没有嵌入到Perl6语言中?
A: 有几个原因:

  1. 本文档的意在独立于给定版本,不与任何给定的perl6版本挂钩。
  2. POD的解析和嵌如工程还不是很稳定,为了避免对运行时造成影响。
  3. 独立于perl6的Github仓库可以让更多的人参与编辑做出贡献。

Q: 我需要从superclasses或者roles中引入方法不
A: 不需要. HTML版本已经引入了所有的superclasses和roles方法,我们可以通过p6doc脚本学习之。

Q: 项目的许可协议是?
A: 所有的代码和文档都基于the Artistic License 2.0 发行,查看LICENSE全文。


版本

I want p6doc and doc.perl6.org to become the No. 1 resource to consult when you want to know something about a Perl 6 feature, be it from the language, or built-in types and routines. I want it to be useful to every Perl 6 programmer.

-- moritz

我希望p6doc和doc.perl6.org成为人们了解perl6特性的首要资源,不管是语言,内建类型和例程。我希望 对每位perl6程序员和需要了解perl6的人都给予最大的帮助 -- moritz


想要的格式:

  • Perl6实现通过在源代码中嵌入P<...>,作为相应的p6doc入口,这将使诸如 &say.WHY的文档条目成动态获取! 而,而不需要在 CORE.setting资源中复制这些文档或者将其编码到二进制文件中。

    例如:

    # In Rakudo's src/core/IO.pm:
    
    #= P<p6doc/&print>
    sub print(|$) { ... }
    
    #= P<p6doc/&say>
    sub say(|$) { ... }
    
    #= P<p6doc/&note>
    sub note(|$) { ... }
    

LICENSE

See LICENSE file for the details of the license of the code in this repository.

This repository also contains code authored by third parties that may be licensed under a different license. Such files indicate the copyright and license terms at the top of the file. Currently these include:

项目点评 (0)

你可以在登录后,对此项目发表评论

3_float_left_people 3_float_left_close