将做业提交到班级博客的一些注意事项

目录

• 1. 概述
• 2. 加入班级博客
• 3 为何采起博文的形式提交做业
• 4. 如何提交做业
• 5. 博文规范
• 7. 代码提交

摘要：

本文介绍课程做业提交规范，解释了为何要以博文的形式提交，怎么让博文便于他人阅读，代码怎么提交。

1. 概述

课程做业发布与提交均采用博文的形式。教师在班级博客发布做业，学生阅读博文，完成做业，并将做业以博文的形式发布在本身的博客。

若是做业涉及到源代码，在博文中只添加核心源代码，并在博文中以超连接的形式给出引用。完整源代码上传到代码托管网站，建议使用 GitHub或者https://coding.net/。

2. 加入班级博客

教师经过课堂派将班级博客邀请连接发给你们，点击加入班级博客，若尚未在博客园开通博客，先注册一个，再点击邀请连接加入博客。实在还没搞定的，参照该博文博客园加入班级详解。

3 为何采起博文的形式提交做业

传统提交做业的方法，将全部东西（包括源代码）放在一个word文件，可读性较差。使用博客提交做业，博文插入源代码能够高亮，便于阅读。除此以外，还有以下好处：

• 在博文以超连接的形式添加引用更加天然，也方便阅读者跳转；
• 每次做业记录本身的所思所想，好的想法值得分享，被更多人看到（好比经过搜索引擎搜索到你的文章），他人的评论也许能够完善你的想法，甚至能够交到志同道合的朋友；
• 提交word文档，会假想阅读者是老师或者助教。但写博文，会假想阅读者是网络上的任何一我的，这样会潜意识地督促本身写得更好（好比更加深刻浅出）；
• 其余

4. 如何提交做业

步骤以下：

• 首先学生需在本身的博客中发布做业随笔
• 点击班级博客进入班级页面，选择右侧“最新做业”中选择须要提交的做业
• 进入做业页面，点击右上角“提交做业”

没搞定的，参照该博文：如何在班级博客中提交做业。

值得注意的是：

• 做业在本身博客发布后，必定要到班级博客提交，不然班级博客后台看不到你的做业，等同于没交。
• 在截止日期以前提交，不然后台关闭，将没法提交，等同于没作

5. 博文规范

对于博文的要求，归结起来是便于他人阅读，即你的想法要很容易而且高效地被阅读者理解。能够从两方面达成这个目标：

• 语言组织。想一想如何深刻浅出地表达本身的想法，尽可能作到每一句话都有它的用途。
• 排版。想一想怎么排版，方便阅读者follow你的逻辑。

我想到的一些便于他人阅读的方法：

• 提交做业时，选择添加新随笔。不要选择文章，不然班级博客上没法看到你的博文，也就没法打分。
• 博客标题格式为：“第*次做业：加上你响亮的标题”（好比“第1次做业：一个工程师成长的心路历程”），方便助教批改做业。
• 在博文的开头，写个摘要，简要说明这篇博文包含哪些内容。建议将摘要的内容，也拷贝到高级选项中的摘要（见图1），这样作的好处是，你的博客会很整洁。
• 使用章节层次，好比2, 2.1, 2.1.1，而且写好标题。
• 合理插入引用。好比引用了其余博文的部份内容，阅读者可能想读整篇文章，你给出引用，这样就方便读者了。
• 在文中须要的地方只给出核心源代码，甚至更进一步，给出一个MWE（Minimal Working Example）。

图1：博客园在随笔添加摘要

7. 代码提交

若是做业涉及到源代码，将程序在本身的机器上调试好，再上传到代码托管网站，建议使用https://coding.net/ 或者GitHub。

为每一次做业建立一个仓库（repository）。而且在博文一开始写明本次做业的项目地址（好比https://github.com/sparkandshine/complex_network）。若是在博文中引用了哪一个文件，以超连接的形式在文中添加引用。

在项目的根目录建立一个名为README.md的文件，对本程序做一个简单介绍，包括但不局限于：

• 这个程序用于作什么
• 怎么运行这个程序，好比参数解释。（能够理解成给出一个用户使用手册）
• 本程序的运行环境（好比所依赖的库）

（1）怎样使用git提交代码

网上有不少手把手教程，好比：

• GitHub Help: https://help.github.com/
• http://rogerdudler.github.io/git-guide/index.zh.html
• http://www.cnblogs.com/hebau-may/p/6382743.html

（2）须要提交的应该有

• 项目的工程文件，例如Eclipse的项目文件
• 项目的源代码
• 一些必要的配置
• 单首创建一个public子目录，存放编译后的可执行程序，这不是标准的软件发布的作法，可是目前你能够先这样提交

（3）不该该提交的有：

• bin目录
• obj目录
• target目录
• .idea目录
• .settings目录
• build目录，compile后生成的文件夹
• .classpath文件
• .DS_Store目录
• .project文件
• *.iml IDE的配置文件、文件夹

能够在项目代码的根目录下建立一个.gitignore文件，把须要忽略的文件夹和文件相对路径逐行添加进去，这样git 提交的时候就会忽略这些子目录和子文件。一个.gitignore模板示例：

/target/
/.idea/
/.settings/
/build/
/.classpath
/.DS_Store/
.project
*.iml
/obj/
/bin/