【问题标题】:Generate Javadocs for easy consumption on mobile phones生成 Javadocs 以便在手机上轻松使用
【发布时间】:2019-07-11 09:35:09
【问题描述】:

我生成了一些 javadocs,看起来不错,我什至可以包含内联代码示例/示例。但是,在移动设备上看起来不太好:

这是我正在使用的插件设置:

     <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-javadoc-plugin</artifactId>
            <version>3.0.1</version>
            <executions>
                <execution>
                    <id>attach-javadocs</id>
                    <goals>
                        <goal>jar</goal>
                    </goals>
                </execution>
            </executions>
            <configuration>
                <additionalOptions>-html5</additionalOptions>
                <additionalJOptions>--allow-script-in-comments</additionalJOptions>
            </configuration>
        </plugin>

也许有一个命令行标志可以用来生成适合移动设备的文档?如果没有,我如何向插件作者添加 +1 以鼓励他们以某种方式使文档响应?

【问题讨论】:

    标签: java responsive-design javadoc maven-javadoc-plugin


    【解决方案1】:

    您是否考虑过创建样式表?

    https://docs.oracle.com/javase/8/docs/technotes/tools/windows/javadoc.html#BEJFCAIH

    javadoc ... -stylesheetfile  path\filename
    

    以下是一些关于在移动设备上使用“响应式 CSS”的链接:

    【讨论】:

    • 它可能有用,但我不擅长 css,我希望到 2019 年 Javadoc 人们可以控制它,但是 idk?
    • 我猜通常程序员在编程(和阅读 javadoc)时不会在手机上这样做,而是在合理大小的屏幕后面,
    • 您不必“擅长 CSS”。只需使用@Media{}“玩转”,看看你想出了什么。这是一个很好的起点:w3schools.com/css/css_rwd_mediaqueries.asp
    • 感谢 paulsm4,如果只是增加字体大小的问题,它可能会起作用,但我很悲观。 @Erwin Bolwidt,我同意 90% 的开发人员会从桌面阅读,但有时我只是想获得灵感时会在手机上阅读文档。
    【解决方案2】:

    这是旧的,但我不喜欢其他答案,因为对我来说,视口的问题使得很难使用@media CSS 来解决它。

    我最终使用标题将变量视口插入到文档中。这不是最好的解决方案,因为 header 不是 head 元素,而是 body 内部的东西,但在现代浏览器中它仍然有效。这是我的代码:

    <!-- Javadoc -->
        <plugin>
            <configuration>
                <header><![CDATA[<meta name='viewport' content='width=device-width, initial-scale=1.0'>]]></header>
                ...
            </configuration>
            ...
        </plugin>
    

    【讨论】:

      猜你喜欢
      • 1970-01-01
      • 2015-03-02
      • 1970-01-01
      • 1970-01-01
      • 2011-11-15
      • 1970-01-01
      • 1970-01-01
      • 2020-12-10
      • 1970-01-01
      相关资源
      最近更新 更多