將做業提交到班級博客的一些注意事項

目錄

• 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/