lacerta-dev/Lacerta
1
0
Fork 0
mirror of https://github.com/lacerta-doc/Lacerta.git synced 2024-11-23 00:13:16 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
Git-likeなバージョン管理システムを持ったドキュメントスキャナ(ミラー)
1,089 Commits 77 Branches 1 Tag 13 MiB
Java 100%
f09d35b8c0
Go to file
ろむねこ f09d35b8c0
Merge pull request #59 from lacerta-doc/data/add_search_stub 
JavaDoc対応
2024-01-13 15:18:32 +09:00
.github Update issue templates 2024-01-08 15:57:51 +09:00
.idea Revert "iroiro" 2024-01-13 14:14:06 +09:00
app Manifestで使用するインテントを明言した 2023-12-22 11:33:11 +09:00
component 暫定)エラーハンドリング 2024-01-09 14:09:27 +09:00
data JavaDoc対応 2024-01-13 14:59:54 +09:00
feature Debug 2024-01-12 12:47:14 +09:00
gradle Revert "ナビゲーショングラフ追加" 2023-12-18 10:34:25 +09:00
model Revert "検索オブジェクト作成 WIP" 2024-01-13 14:14:07 +09:00
processor index廃止 2024-01-09 17:23:56 +09:00
shared 重複を削除, 名前を統一 2024-01-11 15:02:41 +09:00
source ログ追加, 保存場所が異常になる問題を修正 2024-01-09 15:52:47 +09:00
utils index廃止 2024-01-09 17:23:08 +09:00
.gitignore Init 2023-12-07 11:27:36 +09:00
build.gradle :feature:home, :feature:search モジュール作成 2023-12-07 14:21:21 +09:00
gradle.properties Init 2023-12-07 11:27:36 +09:00
gradlew Init 2023-12-07 11:27:36 +09:00
gradlew.bat Init 2023-12-07 11:27:36 +09:00
README.md Readme.mdに説明を追加 2024-01-11 10:59:36 +09:00
settings.gradle アイコン用ようパッケージ追加 2023-12-18 00:33:37 +09:00

README.md

Lacerta

WIP

モジュール設計

Untitled Diagram(2)

メモ

モジュール構成

モジュール一覧

  • component : コンポーネント
    • common : 共通コンポーネント
      • UIの中で共通で使う要素(メニューアイテムとか)
    • scanner : スキャナー
      • スキャナーの実装
    • viewer : ビューワー
      • ドキュメントビューワーの実装
  • data : データ
    • UIからデータを取得/保存するためのラッパーモジュール
    • Document : ドキュメント関係
      • WIP(JavaDocを参照してください, 余裕があったら追記します)
  • feature : 機能モジュール(ナビゲーションからみた機能で分割)
    • common: 共通機能
      • 設定画面とか、どこからでも呼ばれうる画面
    • debug: デバッグメニュー
    • home: ホーム画面
    • library: ライブラリ画面
    • scan: スキャン画面
    • search: 検索画面
  • model : モデル
    • データモデルをまとめたモジュール (WIP)
    • document : ドキュメント
    • meta : メタデータ
  • processor : プロセッサ
    • いくつかの処理をまとめたモジュール
      • DocumentProcessor : ドキュメント処理（ドキュメントにページを追加したり更新したり）
  • shared :
    • 共有リソース
  • source : ソース
    • (バックエンドが使うのでとりあえず後回し、フロントから直接操作することは絶対にありません)
  • utils : ユーティリティ
    • ちょっとしたユーティリティをまとめたモジュール
    • LacertaLogger : ロガー
    • XmlMetaParser : XMLメタデータパーサー(フロントから直接操作することは絶対にありません)

コーディング規則/推奨(WIP)

規則

  • // TODOコメントには任意のsuffixを付ける
    • 全員が同じ// TODO:を使っていると検索がむずかしくなるため
    • (例: // TODO-rca:)

推奨

  • マジックナンバーは控える(必要な場合もあるので)