庫的 dart 文檔，為什么沒有記錄主要的 function？

Question

Hi i have build a blockchain and would like to document the api endpoints written in the main function now i have used dart doc to generate a documentation but it exludes the main function, does anyone know how to include it? https://github.com/ketuf/gladiato.rs

Answer 1

請參閱此處的 Github 問題： https://github.com/dart-lang/dartdoc/issues/3096 。 目前， /lib/src中的任何內容都不能為其生成文檔，因為它被視為私有庫。 您可以將特定文件導出到/lib中的庫，這意味着將為這些文件生成文檔： https://dart.dev/guides/libraries/create-library-packages 。

直接在lib下，主庫文件shelf.dart，從lib/src的幾個文件中導出API。 為避免暴露比預期更多的 API，並為開發人員提供包的整個公共 API 的概述，shelf.dart 使用 show 來准確指定要導出的符號：

 export 'src/cascade.dart' show Cascade; export 'src/handler.dart' show Handler; export 'src/hijack_exception.dart' show HijackException; export 'src/middleware.dart' show Middleware, createMiddleware; export 'src/middleware/add_chunked_encoding.dart' show addChunkedEncoding; export 'src/middleware/logger.dart' show logRequests; export 'src/middleware_extensions.dart' show MiddlewareExtensions; export 'src/pipeline.dart' show Pipeline; export 'src/request.dart' show Request; export 'src/response.dart' show Response; export 'src/server.dart' show Server; export 'src/server_handler.dart' show ServerHandler;