Jelajahi Sumber

完善代码规范要求

LTCatt 5 tahun lalu
induk
melakukan
15e10eb37b

+ 2 - 2
启动器/备份设置.xaml

@@ -5,7 +5,7 @@
     <StackPanel Margin="25,40,23,15">
         <TextBlock TextWrapping="Wrap" Margin="0,0,0,4" LineHeight="17"
                    Text="PCL2 会在 PCL 文件夹中存储部分个性化设置(例如音乐、背景图片、启动器样式、自定义主页等),不包含个人信息。&#xa;如果你正在制作整合包,且需要保留所设置的启动器个性化内容,你就需要在整合包中包含该文件夹。"/>
-        <TextBlock TextWrapping="Wrap" Margin="0,15,0,7" FontSize="15" Foreground="{DynamicResource ColorBrush2}"
+        <TextBlock TextWrapping="Wrap" Margin="0,12,0,7" FontSize="15" Foreground="{DynamicResource ColorBrush2}"
                    Text="具体步骤" />
         <TextBlock TextWrapping="Wrap" Margin="0,0,0,4"
                    Text="打开 PCL2 主程序所在文件夹,将该文件夹下的 PCL 文件夹复制到合适位置即可。"/>
@@ -15,7 +15,7 @@
     <StackPanel Margin="25,40,23,15">
         <TextBlock TextWrapping="Wrap" Margin="0,0,0,4" LineHeight="17"
                    Text="PCL2 会在注册表中存储部分个人设置(例如隐藏主题、账号密码、Java 路径等),在重装系统前有必要先备份其中的内容。&#xa;需要注意的是,账号密码、隐藏主题等敏感信息只能在同一台电脑上进行备份、还原,无法在更换电脑的情况下进行迁移。"/>
-        <TextBlock TextWrapping="Wrap" Margin="0,15,0,7" FontSize="15" Foreground="{DynamicResource ColorBrush2}"
+        <TextBlock TextWrapping="Wrap" Margin="0,12,0,7" FontSize="15" Foreground="{DynamicResource ColorBrush2}"
                    Text="具体步骤" />
         <TextBlock TextWrapping="Wrap" Margin="0,0,0,4" LineHeight="17"
                    Text="1. 右键开始菜单图标,选择 “运行”,在对话框中输入 regedit 并确认。&#xa;2. 在弹出的窗口左边栏打开 HKEY_CURRENT_USER\Software\PCL 文件夹。&#xa;3. 右键左边栏中的 PCL 文件夹,选择 “导出”。此后,双击导出的文件即可导入配置。"/>

+ 2 - 2
帮助/提交帮助 - GitHub Desktop.xaml

@@ -9,8 +9,8 @@
         <local:MyListItem Margin="0,2,0,10" Logo="pack://application:,,,/images/Blocks/CommandBlock.png" SnapsToDevicePixels="True" Type="Clickable" PaddingRight="4"
                             Title="GitHub Desktop 使用入门" Info="GitHub 的官方教程文档页,根据其中的内容完成安装与登录即可" EventType="打开网页" EventData="https://docs.github.com/cn/desktop/installing-and-configuring-github-desktop/getting-started-with-github-desktop#part-1-installing-and-authenticating" />
         <TextBlock TextWrapping="Wrap" Margin="0,0,0,4" LineHeight="17"
-                    Text="打开你Clone的仓库的本地文件夹,在文件浏览器中,开启“显示隐藏的项目选项以选中.git文件夹。&#xa;并将整个PCL2Help内的内容,复制到PCL/Help文件夹下”"/>
-        <local:MyHint Margin="0,0,0,15" Text="注意,在剪切后 .git 文件夹必须位于 PCL\Help,而不能在 PCL\Help\PCL2Help 子文件夹中。" />
+                    Text="打开你Clone的仓库的本地文件夹,在文件浏览器中,开启“显示隐藏的项目选项以选中.git文件夹。&#xa;此后,将整个PCL2Help内的内容剪切到 PCL/Help 文件夹下。"/>
+        <local:MyHint Margin="0,0,0,15" Text="在剪切后 .git 文件夹必须位于 PCL\Help,而不能在 PCL\Help\PCL2Help 子文件夹中" />
         <TextBlock TextWrapping="Wrap" Margin="0,0,0,4" LineHeight="17"
                     Text="使用你喜爱的编辑器编辑文件,并保存。"/>
         <TextBlock TextWrapping="Wrap" Margin="0,0,0,4" LineHeight="17"

+ 2 - 2
帮助/提交帮助 - VSCode.xaml

@@ -10,9 +10,9 @@
                     Text="在主界面按下“F1”键,输入“Git Clone”。&#xa;复制你Fork的仓库地址,粘贴到文本框以Clone。"/>
         <TextBlock TextWrapping="Wrap" Margin="0,0,0,4" LineHeight="17"
                     Text="完成后,刚才选择的文件夹中会生成名为 PCL2Help 的子文件夹。 将 PCL2Help 文件夹中的内容剪切到 PCL\Help 中。"/>
+        <local:MyHint Margin="0,0,0,15" Text="在剪切后 .git 文件夹必须位于 PCL\Help,而不能在 PCL\Help\PCL2Help 子文件夹中" />
         <TextBlock TextWrapping="Wrap" Margin="0,0,0,4" LineHeight="17"
-                    Text="最后,点击左边栏 → 源代码管理 → 打开文件夹,选择 Help 文件夹即可。 此时在 VSCode 打开任意文件,你若能在左下角的时间线中查看到该文件的变更记录,就代表你已经正确完成了帮助库获取。"/>
-        <local:MyHint Margin="0,0,0,15" Text="注意,在剪切后 .git 文件夹必须位于 PCL\Help,而不能在 PCL\Help\PCL2Help 子文件夹中。" />
+                    Text="最后,点击左边栏 → 源代码管理 → 打开文件夹,选择 Help 文件夹即可。"/>
         <TextBlock TextWrapping="Wrap" Margin="0,0,0,4" LineHeight="17"
                     Text="在获取帮助库后,你就可以按照正常自定义帮助的方式对帮助库进行修改了,修改后提交 Pull Request 即可。"/>
     </StackPanel>

+ 34 - 1
帮助/提交帮助.xaml

@@ -33,9 +33,42 @@
     </StackPanel>
 </local:MyCard>
 
+<local:MyCard Title="规范" Margin="0,0,0,15">
+    <StackPanel Margin="25,40,23,15">
+	    <TextBlock TextWrapping="Wrap" Margin="0,0,0,4"
+                   Text="1. 使用官方视角,而不是第三方视角。" />
+	    <TextBlock TextWrapping="Wrap" Foreground="#DD4411" Margin="0,0,0,2"
+                   Text="    ×  要修改龙猫的帮助,在提交 Pull Request 后需要等待龙猫审核" />
+	    <TextBlock TextWrapping="Wrap" Foreground="#229922" Margin="0,0,0,10"
+                   Text="    √  要修改 PCL2 的内置帮助,在提交 Pull Request 后需要等待审核" />
+	    <TextBlock TextWrapping="Wrap" Margin="0,0,0,4"
+                   Text="2. 使用书面化的正式语言,避免出现口语化的表达。" />
+	    <TextBlock TextWrapping="Wrap" Foreground="#DD4411" Margin="0,0,0,2"
+                   Text="    ×  内测版与公开版有啥区别,我该用哪个?" />
+	    <TextBlock TextWrapping="Wrap" Foreground="#229922" Margin="0,0,0,10"
+                   Text="    √  内测版与公开版有什么区别,我应当如何选择?" />
+	    <TextBlock TextWrapping="Wrap" Margin="0,0,0,4"
+                   Text="3. 注意大小写。在中文与非中文的连接处添加一个空格。描述本启动器时统一使用 “PCL2”。" />
+	    <TextBlock TextWrapping="Wrap" Foreground="#DD4411" Margin="0,0,0,2"
+                   Text="    ×  进入pcl的设置页,如果没有安装64位java,最多就只能分配1G内存" />
+	    <TextBlock TextWrapping="Wrap" Foreground="#229922" Margin="0,0,0,10"
+                   Text="    √  进入 PCL2 的设置页,如果没有安装 64 位 Java,最多就只能分配 1G 内存" />
+	    <TextBlock TextWrapping="Wrap" Margin="0,0,0,4"
+                   Text="4. 添加的帮助应当对多数人有用;添加的网站需要是有帮助性质、有一定知名度的中文网站,而不仅是你自己常用的网站。" />
+	    <TextBlock TextWrapping="Wrap" Foreground="#DD4411" Margin="0,0,0,2"
+                   Text="    ×  如何在 IC2 制作核电站;添加 Bilibili;添加 MC 命令生成器" />
+	    <TextBlock TextWrapping="Wrap" Foreground="#229922" Margin="0,0,0,10"
+                   Text="    √  如何设置 MC 的皮肤;添加 Minecraft Wiki" />
+	    <TextBlock TextWrapping="Wrap" Margin="0,0,0,4"
+                   Text="5. 修改文件后,请在 JSON 与 XAML 文件的开头添加自己的名字。格式见已有的文件。" />
+    </StackPanel>
+</local:MyCard>
+
 <local:MyCard Title="下一步计划" Margin="0,0,0,15">
     <StackPanel Margin="25,40,23,15">
 	    <TextBlock TextWrapping="Wrap" Margin="0,0,0,4" LineHeight="17"
-                   Text="目前我们需要将 PCL2 帮助站中的常见内容搬运到帮助库中,以及补充 MC 中的常见问题(例如 Mod、光影安装等),你可以考虑添加这些帮助页面。" />
+                   Text="目前我们需要将 PCL2 帮助站中的常见内容搬运到帮助库中,以及补充 MC 游戏过程中的常见问题。你可以考虑添加这些帮助,或者继续修改目前已有的页面。" />
+        <local:MyButton MinWidth="180" Height="35" Padding="13,0" Margin="0,4,20,4" HorizontalAlignment="Left" ColorType="Highlight"
+                        Text="打开 PCL2 帮助站" EventType="打开网页" EventData="https://pcl2-help.gitee.io/" />
     </StackPanel>
 </local:MyCard>