创建 dart flutter 的 doc文档并部署

最新推荐文章于 2024-05-22 09:35:10 发布
最新推荐文章于 2024-05-22 09:35:10 发布
阅读量2.1k 收藏
点赞数 1
分类专栏： flutter 文章标签： dart doc flutter
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_28478281/article/details/87283397
版权
本文档介绍了如何创建 Dart Flutter 的 API 文档，并详细阐述了如何进行本地部署和部署到 Gitee Pages，包括调整搜索限制以提高使用体验。
摘要由CSDN通过智能技术生成

https://docs.flutter.io/ 是 flutter 的 api 文档页

但是这个文档页有的时候不那么好访问, 也许你有自己的页面,或者你就是想简单的搭建一个 pages 到 gitee/github 上方便你以后的访问

本篇就来教你怎么简单的达成这个目的

gitee 部署完成后是这样的 https://kikt.gitee.io/flutter-doc/

准备工作

  1. 一个终端工具
  2. dart sdk
  3. 一个 web 服务器(pages)

作为一个 flutter/dart 开发者,sdk 肯定是必备工具了

如果你运行过 flutter doctor 命令,则 flutter 自带的 sdk 就会存在在的系统内 ${FLUTTER_HOME}/bin/cache/dart-sdk 这里替换为自己的 flutter sdk 的文件夹

20190131085751.png
这里可以看见 dartdoc 这个就是创建文档的工具了

先进入 sdk 下的 packages/flutter 文件夹

然后运行$FLUTTER_HOME/bin/cache/dart-sdk/bin/dartdoc .命令 $FLUTTER_HOME 为你的 flutter sdk 所在目录

最低0.47元/天 解锁文章
做人要简单
关注
专栏目录
Dart 2.17 现已发布: 工作效率与平台集成
谷歌开发者
05-27 361
作者 / Michael Thomsen, Product Manager working on Dart and Flutter 我们在 Google I/O 大会上发布了全新的 2.17 版 Dart SDK。此版本构建于我们的核心主题之上，即领先的工作效率与平台可移植性。Dart 2.17 带来了新的语言特性，包括在枚举中支持成员变量、改进超类参数继承及提高命名参数的灵活性等。我们推出全新的主要版本 package:lints 来帮助大家根据最佳实践检查 Dart 代码。同时，我们还大幅更新了核心库的
dartdoc:Dart的API文档工具
04-09
达特多克 使用dartdoc为您的Dart包生成HTML文档。 有关对dartdoc项目进行贡献的信息，请参阅 。 有关托管Dart API文档的问题/详细信息，请参阅 。 安装dartdoc 运行pub global activate dartdoc以安装与您的SDK兼容的最新版本的dartdoc。 生成文档 从包的根目录运行dartdoc 。 以下是dartdoc本身进行记录的示例： $ dartdoc Documenting dartdoc... Initialized dartdoc with 766 libraries in 63.9 seconds Generating docs for library dartdoc from package:dartdoc/dartdoc.dart... Validating docs... no issues found Doc
dart-doc_coverage
06-08
Dart 文档覆盖率 Dart 文档覆盖工具检查一个 Dart 库（或包），判断公共 API 的评论。 Dart doc coverage 精确检查将出现在 dartdocs.org 上的注释（例如 ） 0%表示库或类对任何方法、变量等有 0 条注释。 100%意味着库或类对每个方法、变量等都有注释，并且根据某些意见，每个注释的格式都正确。 目前，Dart doc coverage 检查了以下评论： 图书馆 班级 类型定义 错误 库级函数 库级变量 类级方法（构造函数、getter、setter、方法、运算符） 类级变量 一般来说，评论的格式应该遵循 。 具体来说，Dart 文档覆盖率工具检查以下规则： 规则 以下应该有注释：类、方法、getter、setter、运算符、构造函数和变量。 任何评论的第一段都应该是一句话描述。 一个方法注释应该至少有两段。 一个变量注释可以只有
Ubuntu 下如何下载GitHub里的文件 和 GRC结合hackrf 实现GMSK文本传输
weixin_42191545的博客
12-13 709
======================================================= Ubuntu 下如何下载GitHub里的文件： 1.安装git： sudo apt-get install git 2.cd到个路径下下载文件，文件地址为：举下面例子就是：https://github.com/aricwang88/hackrf_GMSK_Transmit_Text.g...
编写高质量Dart程序-文档注释参考
Marswill
08-17 2621
注释 要像句子一样格式化评论。 不要在文档中使用块注释。 Doc注释 使用///文档注释来记录成员和类型。 优先为公共api编写文档注释。 考虑写一个库级别的文档注释 考虑为私有api编写文档注释。 用一句话总结开始doc注释。 一定要把“doc注释”的第一句话分隔成自己的段落。 避免与周围的上下文冗余。 优先用第三人称动词开始函数或方法注释。 优先用名词短语开始变量、getter或se...
flutter 生成文档,如何在本地存储/外部Flutter中创建文件夹？
weixin_42504058的博客
12-24 375
import 'package:path_provider/path_provider.dart';import 'dart:io';void createAppFolder() async {final directory = await getExternalStorageDirectory();final dirPath = '${directory.path}/some_name' ;aw...
Flutter androidstudio-配置.doc
08-15
进入“Preferences”（Windows/MacOS上的“Settings”），在左侧导航栏中选择“Plugins”，然后搜索并安装“Flutter”和“Dart”插件。安装完成后，重启Android Studio。 6. **创建Flutter项目**： 在Android ...
Flutter 2(1)，还在等机会
m0_64604178的博客
12-09 604
@override Widget build(BuildContext context) => MaterialApp( title: ‘Flutter TextField Key Binding Demo’, home: Scaffold(body: UnforgivingTextField()), ); } /// A text field that clears itself if the user tries to back up or correct /// something. class
使用Dart进行文档生成：让代码解释自身的力量
最新发布
gitblog_00008的博客
05-22 385
使用Dart进行文档生成：让代码解释自身的力量 项目地址:https://gitcode.com/dart-lang/dartdoc 项目简介 Dart documentation generator 是一个强大的工具，通过简单的命令行调用，它能为你手中的Dart包自动生成HTML格式的文档。无需复杂的配置，只需运行 dart doc 即可轻松实现。这个开源项目旨在帮助开发者更高效地管理和分享他们...
flutter_filereader:Flutter实现的本地文件(pdf word excel 等)查看插件,非在线预览
05-17
Flutter FileReader 本地文件视图小部件，支持多种文件类型，例如Doc Eexcl PPT TXT等，Android由腾讯X5实现（不支持GooglePlay），iOS由WKWebView实现 依靠它 将此添加到包的pubspec.yaml文件中： 1.9.1 dependencies: flutter_filereader: ^1.0.0 1.12.x dependencies: flutter_filereader: ^2.2.0 支持文件类型 iOS docx,doc,xlsx,xls,pptx,ppt,pdf,txt,jpg,jpeg,png Android docx,doc,xlsx,xls,pptx,ppt,pdf,txt 用法 的iOS 确保将以下密钥添加到iOS的Info.plist <key>io.flutter.embedded
flutter_file_preview:用于Flutter App的PDF，Word，Excel和PowerPoint Viewer
05-06
flutter_file_preview PDF, Word, Excel, and PowerPoint Viewer For Flutter App Getting Started 这是一个Flutter的Office文件预览插件。 支持同时支持本地和在线PDF、Word、Excel、PowerPoint等文件预览。 Android使用的是 iOS使用的是原生WKWebView 使用方法 pubspec.yaml中添加 file_preview: git: url: git://github.com/aliyoge/flutter_file_preview.git 在文件中使用 import 'package:flutter_file_preview/flutter_file_preview.dart'; # 预览在线文件 FlutterFilePreview.
Flutter(Dart)开发规范及相关技巧总结
ithouse的专栏
06-04 1232
基础规范篇 文件命名 文件名有多个单词的话，需要使用下划线进行分割，且单词均为小写。 字符串相关 ①普通字符串建议使用单引号括起来，而不是双引号，当然非要使用双引号也是没有错误的，习惯问题。 ②使用三个引号(三个单引号或三个双引号都可以)创建多行字符串 String str = '''Hello Dart'''; ③使用r创建原始raw字符串 // 如果没有r，则转义字符会生效(换行) String rawStr = r'Hello \n D
flutter 生成文档_flutter 如何实现文件读写(使用篇)
weixin_39644494的博客
02-15 326
flutter文件读写可以对磁盘文件进行操作，实现某些业务场景，那么我们开始来讲下这个文件读写操作。使用的库插件(package)dart:io(用于数据处理)path_provider (用于获取路劲)操作步骤1.获取正确的本地路径2.创建指向文件位置的引用3.写入数据到文件内4.从文件读取数据**1.获取正确的本地路径 **我们获取路劲用的是这个插件path_provider可以看到里面提供了...
Flutter基础
04-06
本课程主要介绍Flutter的核心知识。Flutter主要用于开发跨平台Android App和iOS App。主要包括Flutter的安装，Flutter布局，常用组件、Android和iOS风格的组件、手势、图像、网络、数据库等核心操作。
牛皮啊！竟然可以为Dubbo接口生成文档了！
emprere的博客
10-03 351
在国内dubbo成为很多互联网公司高并发分布式场景下rpc框架的首选，dubbo从开源至今经历过蛮多的过程，从开源到中间的停止维护，经过三年的沉寂，2017年9月，阿里巴巴宣布重启dub...
Dart 2.17 正式发布
Flutter 社区
05-16 2517
文/ Michael Thomsen, Google Dart 团队产品经理，2022 年 5 月 12 日发表于 Dart 官方博客 随着 Flutter 3 在本次 I/O 大会的发布，我们也同时正式发布了 Dart 2.17 稳定版 SDK。这个版本的发布是围绕着我们的核心主题构建的，即：领先的生产力和平台可移植性。 Dart 2.17 提供了新的语言特性：枚举支持成员变量、改进的超类参数继承，以及更为灵活的命名参数。我们同时为 package:lints 开启了 2.x 版本，这是一套官方的 lin
Flutter App开发基础Dart语言入门一个文档就够了
热门推荐
Marswill
08-01 2万+
很多人可能听说过React Native 听说过Weex但是没有听说过Flutter，相比之下Flutter的出现比较晚。因为在2018年2月27日才出现的Flutter的bate1版本。而在2015年Dart开发者峰会上亮相了Flutter的第一个版本叫做Sky。从时间来看比weex的出现早点儿。为什么拿这三个框架来说呢？因为他们有共性，那就是构建APP的用户界面。 Flutter的身...
flutter 打开办公文件 pdf ppt xlsx 等等（仅Android）
qq_36071410的博客
03-05 5284
项目地址： https://github.com/mrliuwen/lw_x5_webview_flutter.git 起因：肺炎闹 产品要 实现方式： 之前在pub库里看到一个X5的 恨遗憾的实现方式是用的直接open。不是用TbsReaderView 后面我替换用TbsReaderView重写了打开文件这部分 需要自定义的懂android原生的小伙伴可以直接在原生部分修改FileActivit...
dart flutter
04-01
Flutter is a mobile app development framework built using Dart. It allows developers to create high-performance, visually appealing, and feature-rich applications for Android, iOS, and the web. ...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

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

余额充值