🤖
技育際で聞いたことをこじらせて掘り下げてみよう -チーム開発編1 ソースコード内のドキュメント-
概要
今回視聴していた技育祭での技術的キーワードを掘り下げていく記事です。
チーム開発のお話から
個人的なチーム開発で取り上げる何となくの範囲
複数人で同時期に開発か、１年ぐらい長期に渡る 個人開発(過去の自分との開発)
複数人の場合、同時期にいろいろな機能を一緒に開発するメンバーがいる
お題で使うコミット
現在、graphqlのリポジトリをフォークしていろいろ遊んでいます。
利用するコミット
今回は、改修する箇所に以下のようにコメントを記述
type PositionData {
x: Int
y: Int
z: Int
}
type Picture {
"""
画像のお絵描きURL
"""
url: String
"""
部屋における画像の座標情報
"""
position: PositionData
}
今回のユースケース
過去に自分または別の方が作っていたお絵描きデータのプログラムを改修
後日
調査するぞい
自分のローカル環境から該当の機能を確認
機能と同じ個所のソースコードを発見
修正
実際に修正してみるぞい
名前項目も後で思い出せるようにコメント付き
type Picture {
"""
画像のお絵描きURL
"""
url: String
"""
描いた絵の名称
"""
name: String
"""
部屋における画像の座標情報
"""
position: PositionData
}
修正したので確認
修正後にplaygroundで反映されているのを確認
名前が追加された！？
というわけで
今回の１回目は「apiの修正依頼→過去の変更箇所を確認→修正して、対応した内容を記載」というチーム開発としての流れを書いてみました。
参考ページ
コメントの仕方参考ページ
Discussion